Abstract Data Output Interface class s. More...

#include "data-output-interface.h"

Inheritance diagram for ns3::DataOutputInterface:

Collaboration diagram for ns3::DataOutputInterface:

Public Member Functions
	DataOutputInterface ()

	~DataOutputInterface () override

std::string	GetFilePrefix () const
	Gets the file prefix of the DataOutputInterface.

virtual void	Output (DataCollector &dc)=0
	Outputs information from the provided DataCollector.

void	SetFilePrefix (const std::string prefix)
	Sets the DataOutputInterface prefix to the provided prefix.

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

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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.

Protected Attributes
std::string	m_filePrefix
	File prefix for the DataOutputInterface.

Additional Inherited Members
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

Abstract Data Output Interface class s.

Definition at line 29 of file data-output-interface.h.

Constructor & Destructor Documentation

◆ DataOutputInterface()

DataOutputInterface::DataOutputInterface ( )

Definition at line 19 of file data-output-interface.cc.

References NS_LOG_FUNCTION.

◆ ~DataOutputInterface()

DataOutputInterface::~DataOutputInterface ( )

override

Definition at line 24 of file data-output-interface.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void DataOutputInterface::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::OmnetDataOutput.

Definition at line 40 of file data-output-interface.cc.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.

Referenced by ns3::OmnetDataOutput::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFilePrefix()

std::string DataOutputInterface::GetFilePrefix ( ) const

Gets the file prefix of the DataOutputInterface.

Returns: File prefix as a string

Definition at line 57 of file data-output-interface.cc.

References m_filePrefix, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId DataOutputInterface::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 31 of file data-output-interface.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Output()

virtual void ns3::DataOutputInterface::Output ( DataCollector & dc )

pure virtual

Outputs information from the provided DataCollector.

Parameters

dc	DataCollector object

Implemented in ns3::OmnetDataOutput, and ns3::SqliteDataOutput.

◆ SetFilePrefix()

void DataOutputInterface::SetFilePrefix ( const std::string prefix )

Sets the DataOutputInterface prefix to the provided prefix.

Parameters

prefix prefix as a string

Definition at line 49 of file data-output-interface.cc.

References m_filePrefix, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_filePrefix

std::string ns3::DataOutputInterface::m_filePrefix

protected

File prefix for the DataOutputInterface.

Definition at line 61 of file data-output-interface.h.

Referenced by ns3::OmnetDataOutput::OmnetDataOutput(), ns3::SqliteDataOutput::SqliteDataOutput(), GetFilePrefix(), ns3::OmnetDataOutput::Output(), ns3::SqliteDataOutput::Output(), and SetFilePrefix().

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

src/stats/model/data-output-interface.h
src/stats/model/data-output-interface.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members