A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::ChannelList Class Reference

the list of simulation channels. More...

#include <channel-list.h>

Public Types

typedef std::vector< Ptr
< Channel > >::const_iterator 
Iterator
 

Static Public Member Functions

static uint32_t Add (Ptr< Channel > channel)
 
static Iterator Begin (void)
 
static Iterator End (void)
 
static Ptr< ChannelGetChannel (uint32_t n)
 
static uint32_t GetNChannels (void)
 

Detailed Description

the list of simulation channels.

Every Channel created is automatically added to this list.

Definition at line 38 of file channel-list.h.

Member Function Documentation

uint32_t ns3::ChannelList::Add ( Ptr< Channel channel)
static
Parameters
channelchannel 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.

Definition at line 167 of file channel-list.cc.

References NS_LOG_FUNCTION_NOARGS.

ChannelList::Iterator ns3::ChannelList::Begin ( void  )
static
Returns
a C++ iterator located at the beginning of this list.

Definition at line 174 of file channel-list.cc.

References NS_LOG_FUNCTION_NOARGS.

ChannelList::Iterator ns3::ChannelList::End ( void  )
static
Returns
a C++ iterator located at the end of this list.

Definition at line 181 of file channel-list.cc.

References NS_LOG_FUNCTION_NOARGS.

Ptr< Channel > ns3::ChannelList::GetChannel ( uint32_t  n)
static
Parameters
nindex of requested channel.
Returns
the Channel associated to index n.

Definition at line 188 of file channel-list.cc.

References NS_LOG_FUNCTION.

uint32_t ns3::ChannelList::GetNChannels ( void  )
static
Returns
the number of channels currently in the list.

Definition at line 195 of file channel-list.cc.

References NS_LOG_FUNCTION_NOARGS.


The documentation for this class was generated from the following files: