A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId ()
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

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

Doxygen introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::FlameStack::FlameStack ( )

Construct a FlameStack helper class.

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

ns3::FlameStack::~FlameStack ( )

Destroy a FlameStack helper class.

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

Member Function Documentation

void ns3::FlameStack::DoDispose ( void  )
virtual
Internal:
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.

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Install a flame stack on the given MeshPointDevice.

Parameters
mpThe Ptr<MeshPointDevice> to use.

Implements ns3::MeshStack.

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

References ns3::flame::FlameProtocol::Install().

+ Here is the call graph for this function:

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

Print flame protocol statistics.

Todo:
report flame counters

Implements ns3::MeshStack.

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

References NS_ASSERT, and ns3::flame::FlameProtocol::Report().

+ Here is the call graph for this function:

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

Reset the statistics.

Todo:
reset flame counters

Implements ns3::MeshStack.

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

References NS_ASSERT, and ns3::flame::FlameProtocol::ResetStats().

+ Here is the call graph for this function:


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