A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::DataCollector Class Reference

#include <data-collector.h>

+ Inheritance diagram for ns3::DataCollector:
+ Collaboration diagram for ns3::DataCollector:

Public Member Functions

 DataCollector ()
virtual ~DataCollector ()
void AddDataCalculator (Ptr< DataCalculator > datac)
void AddMetadata (std::string key, std::string value)
void AddMetadata (std::string key, double value)
void AddMetadata (std::string key, uint32_t value)
DataCalculatorList::iterator DataCalculatorBegin ()
DataCalculatorList::iterator DataCalculatorEnd ()
void DescribeRun (std::string experiment, std::string strategy, std::string input, std::string runID, std::string description="")
std::string GetDescription () const
std::string GetExperimentLabel () const
std::string GetInputLabel () const
std::string GetRunLabel () const
std::string GetStrategyLabel () const
MetadataList::iterator MetadataBegin ()
MetadataList::iterator MetadataEnd ()
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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 ()
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Private Attributes

DataCalculatorList m_calcList
std::string m_description
std::string m_experimentLabel
std::string m_inputLabel
MetadataList m_metadata
std::string m_runLabel
std::string m_strategyLabel

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.

Detailed Description

Definition at line 46 of file data-collector.h.

Constructor & Destructor Documentation

DataCollector::DataCollector ( )

Definition at line 33 of file data-collector.cc.

References NS_LOG_FUNCTION_NOARGS.

DataCollector::~DataCollector ( )
virtual

Definition at line 38 of file data-collector.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void DataCollector::AddDataCalculator ( Ptr< DataCalculator datac)

Definition at line 71 of file data-collector.cc.

References m_calcList.

void DataCollector::AddMetadata ( std::string  key,
std::string  value 
)

Definition at line 93 of file data-collector.cc.

References m_metadata.

void DataCollector::AddMetadata ( std::string  key,
double  value 
)

Definition at line 110 of file data-collector.cc.

References m_metadata.

void DataCollector::AddMetadata ( std::string  key,
uint32_t  value 
)

Definition at line 100 of file data-collector.cc.

References m_metadata.

DataCalculatorList::iterator DataCollector::DataCalculatorBegin ( )

Definition at line 80 of file data-collector.cc.

References m_calcList.

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

+ Here is the caller graph for this function:

DataCalculatorList::iterator DataCollector::DataCalculatorEnd ( )

Definition at line 86 of file data-collector.cc.

References m_calcList.

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

+ Here is the caller graph for this function:

void DataCollector::DescribeRun ( std::string  experiment,
std::string  strategy,
std::string  input,
std::string  runID,
std::string  description = "" 
)
void DataCollector::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.

Definition at line 43 of file data-collector.cc.

References m_calcList, m_metadata, and NS_LOG_FUNCTION_NOARGS.

std::string ns3::DataCollector::GetDescription ( ) const
inline

Definition at line 61 of file data-collector.h.

References m_description.

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

+ Here is the caller graph for this function:

std::string ns3::DataCollector::GetExperimentLabel ( ) const
inline

Definition at line 57 of file data-collector.h.

References m_experimentLabel.

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

+ Here is the caller graph for this function:

std::string ns3::DataCollector::GetInputLabel ( ) const
inline

Definition at line 59 of file data-collector.h.

References m_inputLabel.

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

+ Here is the caller graph for this function:

std::string ns3::DataCollector::GetRunLabel ( ) const
inline

Definition at line 60 of file data-collector.h.

References m_runLabel.

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

+ Here is the caller graph for this function:

std::string ns3::DataCollector::GetStrategyLabel ( ) const
inline

Definition at line 58 of file data-collector.h.

References m_strategyLabel.

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

+ Here is the caller graph for this function:

MetadataList::iterator DataCollector::MetadataBegin ( )

Definition at line 121 of file data-collector.cc.

References m_metadata.

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

+ Here is the caller graph for this function:

MetadataList::iterator DataCollector::MetadataEnd ( )

Definition at line 127 of file data-collector.cc.

References m_metadata.

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

+ Here is the caller graph for this function:

Member Data Documentation

DataCalculatorList ns3::DataCollector::m_calcList
private
std::string ns3::DataCollector::m_description
private

Definition at line 81 of file data-collector.h.

Referenced by DescribeRun(), and GetDescription().

std::string ns3::DataCollector::m_experimentLabel
private

Definition at line 77 of file data-collector.h.

Referenced by DescribeRun(), and GetExperimentLabel().

std::string ns3::DataCollector::m_inputLabel
private

Definition at line 79 of file data-collector.h.

Referenced by DescribeRun(), and GetInputLabel().

MetadataList ns3::DataCollector::m_metadata
private

Definition at line 83 of file data-collector.h.

Referenced by AddMetadata(), DoDispose(), MetadataBegin(), and MetadataEnd().

std::string ns3::DataCollector::m_runLabel
private

Definition at line 80 of file data-collector.h.

Referenced by DescribeRun(), and GetRunLabel().

std::string ns3::DataCollector::m_strategyLabel
private

Definition at line 78 of file data-collector.h.

Referenced by DescribeRun(), and GetStrategyLabel().


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