this class manages a list of SSrecords More...

#include "ss-manager.h"

Inheritance diagram for ns3::SSManager:

Collaboration diagram for ns3::SSManager:

Public Member Functions
	SSManager ()

	~SSManager () override

SSRecord *	CreateSSRecord (const Mac48Address &macAddress)
	Create SS record.

void	DeleteSSRecord (Cid cid)
	Delete SS record.

Mac48Address	GetMacAddress (Cid cid) const
	Get MAC address by CID.

uint32_t	GetNRegisteredSSs () const
	Get number of registered SSs.

uint32_t	GetNSSs () const
	Get number of SSs.

SSRecord *	GetSSRecord (Cid cid) const
	returns the ssrecord which has been assigned this cid.

SSRecord *	GetSSRecord (const Mac48Address &macAddress) const
	Get SS record.

std::vector< SSRecord * > *	GetSSRecords () const
	Get SS records.

bool	IsInRecord (const Mac48Address &macAddress) const
	Check if address is in record.

bool	IsRegistered (const Mac48Address &macAddress) const
	Check if address is registered.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
std::vector< SSRecord * > *	m_ssRecords
	the SS records

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

this class manages a list of SSrecords

See also: SSrecord

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

Constructor & Destructor Documentation

◆ SSManager()

ns3::SSManager::SSManager ( )

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

References m_ssRecords.

◆ ~SSManager()

ns3::SSManager::~SSManager ( )

override

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

References m_ssRecords.

Member Function Documentation

◆ CreateSSRecord()

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

Create SS record.

Parameters

macAddress the MAC address

Returns: pointer to the SS record

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

References m_ssRecords.

◆ DeleteSSRecord()

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

Delete SS record.

Parameters

cid the CID

Definition at line 126 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:

◆ GetMacAddress()

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

Get MAC address by CID.

Parameters

cid the CID

Returns: the MAC address

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

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

Here is the call graph for this function:

◆ GetNRegisteredSSs()

uint32_t ns3::SSManager::GetNRegisteredSSs ( ) const

Get number of registered SSs.

Returns: the number of registered SSs

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

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

◆ GetNSSs()

uint32_t ns3::SSManager::GetNSSs ( ) const

Get number of SSs.

Returns: the number of SSs

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

References m_ssRecords.

◆ GetSSRecord() [1/2]

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

cid	the cid to be matched

Returns: pointer to the ss record matching the cid

Definition at line 72 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:

◆ GetSSRecord() [2/2]

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

Get SS record.

Parameters

macAddress the MAC address

Returns: pointer to the SS record

Definition at line 57 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:

◆ GetSSRecords()

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

Get SS records.

Returns: a vector of pointers to the SS records

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

References m_ssRecords.

◆ GetTypeId()

TypeId ns3::SSManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsInRecord()

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

Check if address is in record.

Parameters

macAddress the MAC address

Returns: whether the address is in the record

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

References m_ssRecords.

◆ IsRegistered()

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

Check if address is registered.

Parameters

macAddress the MAC address

Returns: whether the address is registered

Definition at line 118 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

◆ m_ssRecords

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

private

the SS records

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

Referenced by SSManager(), ~SSManager(), CreateSSRecord(), DeleteSSRecord(), GetNRegisteredSSs(), GetNSSs(), GetSSRecord(), GetSSRecord(), GetSSRecords(), and IsInRecord().

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

src/wimax/model/ss-manager.h
src/wimax/model/ss-manager.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SSManager()

◆ ~SSManager()

Member Function Documentation

◆ CreateSSRecord()

◆ DeleteSSRecord()

◆ GetMacAddress()

◆ GetNRegisteredSSs()

◆ GetNSSs()

◆ GetSSRecord() [1/2]

◆ GetSSRecord() [2/2]

◆ GetSSRecords()

◆ GetTypeId()

◆ IsInRecord()

◆ IsRegistered()

Member Data Documentation

◆ m_ssRecords