A Discrete-Event Network Simulator
API
ns3::DataOutputInterface Class Referenceabstract

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. More...
 
virtual void Output (DataCollector &dc)=0
 Outputs information from the provided DataCollector. More...
 
void SetFilePrefix (const std::string prefix)
 Sets the DataOutputInterface prefix to the provided prefix. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated 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...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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 () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

std::string m_filePrefix
 File prefix for the DataOutputInterface. More...
 

Additional Inherited Members

Detailed Description

Abstract Data Output Interface class s.

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

Constructor & Destructor Documentation

◆ DataOutputInterface()

DataOutputInterface::DataOutputInterface ( )

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

References NS_LOG_FUNCTION.

◆ ~DataOutputInterface()

DataOutputInterface::~DataOutputInterface ( )
override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void DataOutputInterface::DoDispose ( void  )
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 51 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 68 of file data-output-interface.cc.

References m_filePrefix, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId DataOutputInterface::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 42 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
dcDataCollector object

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

◆ SetFilePrefix()

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

Sets the DataOutputInterface prefix to the provided prefix.

Parameters
prefixprefix as a string

Definition at line 60 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

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