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.

	~FlameStack () override
	Destroy a FlameStack helper class.

void	DoDispose () override
	Break any reference cycles in the installer helper.

bool	InstallStack (Ptr< MeshPointDevice > mp) override
	Install a flame stack on the given MeshPointDevice.

void	Report (const Ptr< MeshPointDevice > mp, std::ostream &) override
	Print flame protocol statistics.

void	ResetStats (const Ptr< MeshPointDevice > mp) override
	Reset the statistics.

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::MeshStack
static TypeId	GetTypeId ()
	Register this type.

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.

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

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

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

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

Constructor & Destructor Documentation

◆ FlameStack()

ns3::FlameStack::FlameStack ( )

Construct a FlameStack helper class.

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

◆ ~FlameStack()

ns3::FlameStack::~FlameStack ( )

override

Destroy a FlameStack helper class.

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

Member Function Documentation

◆ DoDispose()

void ns3::FlameStack::DoDispose ( )

overridevirtual

Break any reference cycles in the installer helper.

Required for ns-3 Object support.

Reimplemented from ns3::Object.

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

◆ GetTypeId()

TypeId ns3::FlameStack::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 20 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 )

overridevirtual

Install a flame stack on the given MeshPointDevice.

Parameters

mp	The Ptr<MeshPointDevice> to use.

Returns: true if successful

Implements ns3::MeshStack.

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

References ns3::CreateObject().

Here is the call graph for this function:

◆ Report()

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

overridevirtual

Print flame protocol statistics.

Parameters

mp	The Ptr<MeshPointDevice> to use.
os	The output stream

Todo: report flame counters

Implements ns3::MeshStack.

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

References NS_ASSERT.

◆ ResetStats()

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

overridevirtual

Reset the statistics.

Parameters

mp	The Ptr<MeshPointDevice> to use.

Todo: reset flame counters

Implements ns3::MeshStack.

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

References NS_ASSERT.

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

src/mesh/helper/flame/flame-installer.h
src/mesh/helper/flame/flame-installer.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FlameStack()

◆ ~FlameStack()

Member Function Documentation

◆ DoDispose()

◆ GetTypeId()

◆ InstallStack()

◆ Report()

◆ ResetStats()