A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
virtual ~DataOutputInterface ()
 
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 ()
 
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)
 

Protected Member Functions

virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- 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...
 

Protected Attributes

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

Additional Inherited Members

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

Detailed Description

Abstract Data Output Interface class s.

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

Constructor & Destructor Documentation

DataOutputInterface::DataOutputInterface ( )

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

References NS_LOG_FUNCTION_NOARGS.

DataOutputInterface::~DataOutputInterface ( )
virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void DataOutputInterface::DoDispose ( void  )
protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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::SqliteDataOutput, and ns3::OmnetDataOutput.

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

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

Referenced by ns3::OmnetDataOutput::DoDispose(), and ns3::SqliteDataOutput::DoDispose().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string DataOutputInterface::GetFilePrefix ( ) const

Gets the file prefix of the DataOutputInterface.

Returns
File prefix as a string

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

References m_filePrefix.

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.

Referenced by main().

+ Here is the caller graph for this function:

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

Sets the DataOutputInterface prefix to the provided prefix.

Parameters
prefixprefix as a string

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

References m_filePrefix.

Member Data Documentation

std::string ns3::DataOutputInterface::m_filePrefix
protected

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