A Discrete-Event Network Simulator
API
ns3::ChannelManager Class Reference

manage 7 WaveChannels and the tx information such as data rate and txPowerLevel. More...

#include "channel-manager.h"

+ Inheritance diagram for ns3::ChannelManager:
+ Collaboration diagram for ns3::ChannelManager:

Classes

struct  WaveChannel
 WaveChannel structure. More...
 

Public Member Functions

 ChannelManager ()
 
virtual ~ChannelManager ()
 
bool GetManagementAdaptable (uint32_t channelNumber)
 
WifiMode GetManagementDataRate (uint32_t channelNumber)
 
uint32_t GetManagementPowerLevel (uint32_t channelNumber)
 
WifiPreamble GetManagementPreamble (uint32_t channelNumber)
 
uint32_t GetOperatingClass (uint32_t channelNumber)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static uint32_t GetCch (void)
 
static uint32_t GetNumberOfWaveChannels (void)
 
static std::vector< uint32_t > GetSchs (void)
 
static TypeId GetTypeId (void)
 Get the type ID. More...
 
static std::vector< uint32_t > GetWaveChannels (void)
 
static bool IsCch (uint32_t channelNumber)
 
static bool IsSch (uint32_t channelNumber)
 
static bool IsWaveChannel (uint32_t channelNumber)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Attributes

std::map< uint32_t, WaveChannel * > m_channels
 list of channels More...
 

Static Private Attributes

static const uint32_t DEFAULT_OPERATING_CLASS = 17
 1609.4-2010 Annex H More...
 

Additional Inherited Members

Detailed Description

manage 7 WaveChannels and the tx information such as data rate and txPowerLevel.


for transmitting VSA management frames.

Config Paths

ns3::ChannelManager is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/ChannelManager"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 62 of file channel-manager.h.

Constructor & Destructor Documentation

◆ ChannelManager()

ns3::ChannelManager::ChannelManager ( )

Definition at line 39 of file channel-manager.cc.

References CCH, m_channels, NS_LOG_FUNCTION, SCH1, SCH2, SCH3, SCH4, SCH5, and SCH6.

◆ ~ChannelManager()

ns3::ChannelManager::~ChannelManager ( )
virtual

Definition at line 51 of file channel-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::ChannelManager::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 173 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetCch()

uint32_t ns3::ChannelManager::GetCch ( void  )
static
Returns
the channel number of WAVE CCH.

Definition at line 57 of file channel-manager.cc.

References CCH, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::WaveHelper::Install().

+ Here is the caller graph for this function:

◆ GetManagementAdaptable()

bool ns3::ChannelManager::GetManagementAdaptable ( uint32_t  channelNumber)
Parameters
channelNumberthe specific channel
Returns
the adaptable mode for management frames

Definition at line 145 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetManagementDataRate()

WifiMode ns3::ChannelManager::GetManagementDataRate ( uint32_t  channelNumber)
Parameters
channelNumberthe specific channel
Returns
the data rate for management frames

Definition at line 152 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetManagementPowerLevel()

uint32_t ns3::ChannelManager::GetManagementPowerLevel ( uint32_t  channelNumber)
Parameters
channelNumberthe specific channel
Returns
the tx power level for management frames

Definition at line 166 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetManagementPreamble()

WifiPreamble ns3::ChannelManager::GetManagementPreamble ( uint32_t  channelNumber)
Parameters
channelNumberthe specific channel
Returns
the preamble for management frames

Definition at line 159 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetNumberOfWaveChannels()

uint32_t ns3::ChannelManager::GetNumberOfWaveChannels ( void  )
static
Returns
the number of WAVE channels.

Definition at line 93 of file channel-manager.cc.

References GetWaveChannels(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::WaveHelper::CreatePhys().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetOperatingClass()

uint32_t ns3::ChannelManager::GetOperatingClass ( uint32_t  channelNumber)
Parameters
channelNumberthe specific channel
Returns
the operating class on this channel

the operating class is unused in the simulation

Definition at line 138 of file channel-manager.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetSchs()

std::vector< uint32_t > ns3::ChannelManager::GetSchs ( void  )
static
Returns
the channel number set of WAVE SCHs.

Definition at line 64 of file channel-manager.cc.

References NS_LOG_FUNCTION_NOARGS, SCH1, SCH2, SCH3, SCH4, SCH5, and SCH6.

◆ GetTypeId()

TypeId ns3::ChannelManager::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file channel-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetWaveChannels()

std::vector< uint32_t > ns3::ChannelManager::GetWaveChannels ( void  )
static
Returns
the channel number set of WAVE channels.

The sequence is CCH, SCH1, SCH2, SCH3, SCH4, SCH5 and SCH6.

Definition at line 78 of file channel-manager.cc.

References CCH, NS_LOG_FUNCTION_NOARGS, SCH1, SCH2, SCH3, SCH4, SCH5, and SCH6.

Referenced by ns3::WaveHelper::Default(), and GetNumberOfWaveChannels().

+ Here is the caller graph for this function:

◆ IsCch()

bool ns3::ChannelManager::IsCch ( uint32_t  channelNumber)
static
Parameters
channelNumberthe specific channel
Returns
whether channel is valid CCH channel

Definition at line 101 of file channel-manager.cc.

References CCH, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::ChannelScheduler::StartSch(), and ns3::ChannelScheduler::StopSch().

+ Here is the caller graph for this function:

◆ IsSch()

bool ns3::ChannelManager::IsSch ( uint32_t  channelNumber)
static
Parameters
channelNumberthe specific channel
Returns
whether channel is valid SCH channel

Definition at line 108 of file channel-manager.cc.

References CCH, NS_LOG_FUNCTION_NOARGS, and SCH6.

◆ IsWaveChannel()

bool ns3::ChannelManager::IsWaveChannel ( uint32_t  channelNumber)
static
Parameters
channelNumberthe specific channel
Returns
whether channel is valid WAVE channel

Definition at line 123 of file channel-manager.cc.

References NS_LOG_FUNCTION_NOARGS, and SCH6.

Referenced by ns3::WaveNetDevice::AddMac(), ns3::WaveHelper::CreateMacForChannel(), and ns3::WaveNetDevice::IsAvailableChannel().

+ Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_OPERATING_CLASS

const uint32_t ns3::ChannelManager::DEFAULT_OPERATING_CLASS = 17
staticprivate

1609.4-2010 Annex H

Definition at line 140 of file channel-manager.h.

◆ m_channels

std::map<uint32_t, WaveChannel *> ns3::ChannelManager::m_channels
private

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