ns3::DataCollector Class Reference

#include <data-collector.h>

Inheritance diagram for ns3::DataCollector:
Inheritance graph
[legend]
Collaboration diagram for ns3::DataCollector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 DataCollector ()
virtual ~DataCollector ()
void DescribeRun (std::string experiment, std::string strategy, std::string input, std::string runID, std::string description="")
std::string GetExperimentLabel () const
std::string GetStrategyLabel () const
std::string GetInputLabel () const
std::string GetRunLabel () const
std::string GetDescription () const
void AddMetadata (std::string key, std::string value)
void AddMetadata (std::string key, double value)
void AddMetadata (std::string key, uint32_t value)
MetadataList::iterator MetadataBegin ()
MetadataList::iterator MetadataEnd ()
void AddDataCalculator (Ptr< DataCalculator > datac)
DataCalculatorList::iterator DataCalculatorBegin ()
DataCalculatorList::iterator DataCalculatorEnd ()

Protected Member Functions

virtual void DoDispose ()

Private Attributes

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

Detailed Description

Definition at line 38 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,
uint32_t  value 
)

Definition at line 100 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,
std::string  value 
)

Definition at line 93 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::SqliteDataOutput::Output(), and ns3::OmnetDataOutput::Output().

DataCalculatorList::iterator DataCollector::DataCalculatorEnd (  ) 

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

References m_calcList.

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

void DataCollector::DescribeRun ( std::string  experiment,
std::string  strategy,
std::string  input,
std::string  runID,
std::string  description = "" 
)
void DataCollector::DoDispose ( void   )  [protected, virtual]

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.

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 53 of file data-collector.h.

References m_description.

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

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

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

References m_experimentLabel.

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

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

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

References m_inputLabel.

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

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

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

References m_runLabel.

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

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

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

References m_strategyLabel.

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

MetadataList::iterator DataCollector::MetadataBegin (  ) 

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

References m_metadata.

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

MetadataList::iterator DataCollector::MetadataEnd (  ) 

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

References m_metadata.

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


Member Data Documentation

std::string ns3::DataCollector::m_description [private]

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

Referenced by DescribeRun(), and GetDescription().

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

Referenced by DescribeRun(), and GetExperimentLabel().

std::string ns3::DataCollector::m_inputLabel [private]

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

Referenced by DescribeRun(), and GetInputLabel().

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

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

std::string ns3::DataCollector::m_runLabel [private]

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

Referenced by DescribeRun(), and GetRunLabel().

std::string ns3::DataCollector::m_strategyLabel [private]

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

Referenced by DescribeRun(), and GetStrategyLabel().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:10:06 2009 for NS-3 by  doxygen 1.6.3