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

this class manages a list of SSrecord More...

#include "ss-manager.h"

+ Inheritance diagram for ns3::SSManager:
+ Collaboration diagram for ns3::SSManager:

Public Member Functions

 SSManager (void)
 
 ~SSManager (void)
 
SSRecordCreateSSRecord (const Mac48Address &macAddress)
 
void DeleteSSRecord (Cid cid)
 
Mac48Address GetMacAddress (Cid cid) const
 
uint32_t GetNRegisteredSSs (void) const
 
uint32_t GetNSSs (void) const
 
SSRecordGetSSRecord (const Mac48Address &macAddress) const
 
SSRecordGetSSRecord (Cid cid) const
 returns the ssrecord which has been assigned this cid. More...
 
std::vector< SSRecord * > * GetSSRecords (void) const
 
bool IsInRecord (const Mac48Address &macAddress) const
 
bool IsRegistered (const Mac48Address &macAddress) const
 
- 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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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 TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::vector< SSRecord * > * m_ssRecords
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

Detailed Description

this class manages a list of SSrecord

See also
SSrecord

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager"

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

Definition at line 37 of file ss-manager.h.

Constructor & Destructor Documentation

ns3::SSManager::SSManager ( void  )

Definition at line 42 of file ss-manager.cc.

References m_ssRecords.

ns3::SSManager::~SSManager ( void  )

Definition at line 47 of file ss-manager.cc.

References m_ssRecords.

Member Function Documentation

SSRecord * ns3::SSManager::CreateSSRecord ( const Mac48Address macAddress)

Definition at line 58 of file ss-manager.cc.

References m_ssRecords.

void ns3::SSManager::DeleteSSRecord ( Cid  cid)

Definition at line 134 of file ss-manager.cc.

References ns3::SSRecord::GetBasicCid(), ns3::SSRecord::GetPrimaryCid(), ns3::SSRecord::GetServiceFlows(), m_ssRecords, and ns3::ServiceFlow::SF_TYPE_ALL.

+ Here is the call graph for this function:

Mac48Address ns3::SSManager::GetMacAddress ( Cid  cid) const

Definition at line 160 of file ss-manager.cc.

References ns3::SSRecord::GetMacAddress(), and GetSSRecord().

+ Here is the call graph for this function:

uint32_t ns3::SSManager::GetNRegisteredSSs ( void  ) const

Definition at line 172 of file ss-manager.cc.

References m_ssRecords, and ns3::WimaxNetDevice::RANGING_STATUS_SUCCESS.

uint32_t ns3::SSManager::GetNSSs ( void  ) const

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

References m_ssRecords.

SSRecord * ns3::SSManager::GetSSRecord ( const Mac48Address macAddress) const

Definition at line 66 of file ss-manager.cc.

References m_ssRecords, and NS_LOG_DEBUG.

Referenced by GetMacAddress(), and IsRegistered().

+ Here is the caller graph for this function:

SSRecord * ns3::SSManager::GetSSRecord ( Cid  cid) const

returns the ssrecord which has been assigned this cid.

Since different types of cids (basic, primary, transport) are assigned different values, all cids (basic, primary and transport) of the ssrecord are matched.

Parameters
cidthe cid to be matched
Returns
the ss record that has the cid

Definition at line 81 of file ss-manager.cc.

References ns3::SSRecord::GetBasicCid(), ns3::SSRecord::GetPrimaryCid(), ns3::SSRecord::GetServiceFlows(), m_ssRecords, NS_LOG_DEBUG, and ns3::ServiceFlow::SF_TYPE_ALL.

+ Here is the call graph for this function:

std::vector< SSRecord * > * ns3::SSManager::GetSSRecords ( void  ) const

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

References m_ssRecords.

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

Definition at line 34 of file ss-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

bool ns3::SSManager::IsInRecord ( const Mac48Address macAddress) const

Definition at line 114 of file ss-manager.cc.

References m_ssRecords.

bool ns3::SSManager::IsRegistered ( const Mac48Address macAddress) const

Definition at line 127 of file ss-manager.cc.

References ns3::SSRecord::GetRangingStatus(), GetSSRecord(), and ns3::WimaxNetDevice::RANGING_STATUS_SUCCESS.

+ Here is the call graph for this function:

Member Data Documentation

std::vector<SSRecord*>* ns3::SSManager::m_ssRecords
private

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