Files
unison/src/node/channel-list.h
2009-09-21 11:21:05 -07:00

75 lines
1.9 KiB
C++

/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef CHANNEL_LIST_H
#define CHANNEL_LIST_H
#include <vector>
#include "ns3/ptr.h"
namespace ns3 {
class Channel;
class CallbackBase;
/**
* \ingroup node
*
* \brief the list of simulation channels.
*
* Every Channel created is automatically added to this list.
*/
class ChannelList
{
public:
typedef std::vector< Ptr<Channel> >::const_iterator Iterator;
/**
* \param channel channel to add
* \returns index of channel in list.
*
* This method is called automatically from Channel::Channel so
* the user has little reason to call it himself.
*/
static uint32_t Add (Ptr<Channel> channel);
/**
* \returns a C++ iterator located at the beginning of this
* list.
*/
static Iterator Begin (void);
/**
* \returns a C++ iterator located at the end of this
* list.
*/
static Iterator End (void);
/**
* \param n index of requested channel.
* \returns the Channel associated to index n.
*/
static Ptr<Channel> GetChannel (uint32_t n);
/**
* \returns the number of channels currently in the list.
*/
static uint32_t GetNChannels (void);
};
}//namespace ns3
#endif /* CHANNEL_LIST_H */