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

Helper class used to install FLAME mesh stack (actually single protocol in this stack) More...

#include "flame-installer.h"

+ Inheritance diagram for ns3::FlameStack:
+ Collaboration diagram for ns3::FlameStack:

Public Member Functions

 FlameStack ()
 Construct a FlameStack helper class. More...
 
 ~FlameStack ()
 Destroy a FlameStack helper class. More...
 
void DoDispose ()
 Break any reference cycles in the installer helper. More...
 
bool InstallStack (Ptr< MeshPointDevice > mp)
 Install a flame stack on the given MeshPointDevice. More...
 
void Report (const Ptr< MeshPointDevice > mp, std::ostream &)
 Print flame protocol statistics. More...
 
void ResetStats (const Ptr< MeshPointDevice > mp)
 Reset the statistics. 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...
 

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 used to install FLAME mesh stack (actually single protocol in this stack)

Introspection did not find any typical Config paths.


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

Definition at line 34 of file flame-installer.h.

Constructor & Destructor Documentation

◆ FlameStack()

ns3::FlameStack::FlameStack ( )

Construct a FlameStack helper class.

Definition at line 39 of file flame-installer.cc.

◆ ~FlameStack()

ns3::FlameStack::~FlameStack ( )

Destroy a FlameStack helper class.

Definition at line 42 of file flame-installer.cc.

Member Function Documentation

◆ DoDispose()

void ns3::FlameStack::DoDispose ( void  )
virtual

Break any reference cycles in the installer helper.

Required for ns-3 Object support.

Reimplemented from ns3::Object.

Definition at line 46 of file flame-installer.cc.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InstallStack()

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

Install a flame stack on the given MeshPointDevice.

Parameters
mpThe Ptr<MeshPointDevice> to use.
Returns
true if successful

Implements ns3::MeshStack.

Definition at line 50 of file flame-installer.cc.

◆ Report()

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

Print flame protocol statistics.

Parameters
mpThe Ptr<MeshPointDevice> to use.
osThe output stream
Todo:
report flame counters

Implements ns3::MeshStack.

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

References NS_ASSERT.

◆ ResetStats()

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

Reset the statistics.

Parameters
mpThe Ptr<MeshPointDevice> to use.
Todo:
reset flame counters

Implements ns3::MeshStack.

Definition at line 65 of file flame-installer.cc.

References NS_ASSERT.


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