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

Helper class to allow easy installation of 802.11s stack. More...

#include "dot11s-installer.h"

+ Inheritance diagram for ns3::Dot11sStack:
+ Collaboration diagram for ns3::Dot11sStack:

Public Member Functions

 Dot11sStack ()
 Create a Dot11sStack() installer helper. More...
 
 ~Dot11sStack ()
 Destroy a Dot11sStack() installer helper. More...
 
void DoDispose ()
 Break any reference cycles in the installer helper. More...
 
bool InstallStack (Ptr< MeshPointDevice > mp)
 Install an 802.11s stack. More...
 
void Report (const Ptr< MeshPointDevice > mp, std::ostream &)
 Iterate through the referenced devices and protocols and print their statistics. More...
 
void ResetStats (const Ptr< MeshPointDevice > mp)
 Reset the statistics on the referenced devices and protocols. More...
 
- 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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 TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::MeshStack
static TypeId GetTypeId (void)
 Register this type. More...
 
- 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...
 

Private Attributes

Mac48Address m_root
 root More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Helper class to allow easy installation of 802.11s stack.

Introspection did not find any typical Config paths.


Attributes

  • Root: The MAC address of root mesh point.

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

Definition at line 32 of file dot11s-installer.h.

Constructor & Destructor Documentation

◆ Dot11sStack()

ns3::Dot11sStack::Dot11sStack ( )

Create a Dot11sStack() installer helper.

Definition at line 44 of file dot11s-installer.cc.

◆ ~Dot11sStack()

ns3::Dot11sStack::~Dot11sStack ( )

Destroy a Dot11sStack() installer helper.

Definition at line 48 of file dot11s-installer.cc.

Member Function Documentation

◆ DoDispose()

void ns3::Dot11sStack::DoDispose ( void  )
virtual

Break any reference cycles in the installer helper.

Required for ns-3 Object support.

Reimplemented from ns3::Object.

Definition at line 52 of file dot11s-installer.cc.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 31 of file dot11s-installer.cc.

References m_root, ns3::MakeMac48AddressAccessor(), ns3::MakeMac48AddressChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InstallStack()

bool ns3::Dot11sStack::InstallStack ( Ptr< MeshPointDevice mp)
virtual

Install an 802.11s stack.

Parameters
mpThe Ptr<MeshPointDevice> to use when setting up the PMP.
Returns
true if successful

Implements ns3::MeshStack.

Definition at line 56 of file dot11s-installer.cc.

References ns3::dot11s::PeerManagementProtocol::GetPeers(), m_root, ns3::MakeCallback(), ns3::PeekPointer(), and ns3::dot11s::HwmpProtocol::PeerLinkStatus().

+ Here is the call graph for this function:

◆ Report()

void ns3::Dot11sStack::Report ( const Ptr< MeshPointDevice mp,
std::ostream &  os 
)
virtual

Iterate through the referenced devices and protocols and print their statistics.

Parameters
mpThe Ptr<MeshPointDevice> to use when setting up the PMP.
osThe output stream

Implements ns3::MeshStack.

Definition at line 84 of file dot11s-installer.cc.

References ns3::WifiNetDevice::GetMac(), ns3::Object::GetObject(), third::mac, and NS_ASSERT.

+ Here is the call graph for this function:

◆ ResetStats()

void ns3::Dot11sStack::ResetStats ( const Ptr< MeshPointDevice mp)
virtual

Reset the statistics on the referenced devices and protocols.

Parameters
mpThe Ptr<MeshPointDevice> to use when setting up the PMP.

Implements ns3::MeshStack.

Definition at line 106 of file dot11s-installer.cc.

References ns3::WifiNetDevice::GetMac(), ns3::Object::GetObject(), third::mac, and NS_ASSERT.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_root

Mac48Address ns3::Dot11sStack::m_root
private

root

Definition at line 79 of file dot11s-installer.h.

Referenced by GetTypeId(), and InstallStack().


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