Collects data. More...

#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)
	Add a DataCalculator object to the DataCollector. More...

void	AddMetadata (std::string key, std::string value)
	Add the key and the value as a pair of strings to the metadata list. More...

void	AddMetadata (std::string key, double value)
	Add the key and the value as a pair of strings to the metadata list. More...

void	AddMetadata (std::string key, uint32_t value)
	Add the key and the value as a pair of strings to the metadata list. More...

DataCalculatorList::iterator	DataCalculatorBegin ()
	Returns an iterator to the beginning of the DataCalculator list. More...

DataCalculatorList::iterator	DataCalculatorEnd ()
	Returns an iterator to the past-the-end of the DataCalculator list. More...

void	DescribeRun (std::string experiment, std::string strategy, std::string input, std::string runID, std::string description="")
	Provide specific parameters to the DataCollector. More...

std::string	GetDescription () const
	Return the description label. More...

std::string	GetExperimentLabel () const
	Return the experiment label. More...

std::string	GetInputLabel () const
	Return the input label. More...

std::string	GetRunLabel () const
	Return the runID label. More...

std::string	GetStrategyLabel () const
	Return the strategy label. More...

MetadataList::iterator	MetadataBegin ()
	Returns an iterator to the beginning of the metadata list. More...

MetadataList::iterator	MetadataEnd ()
	Returns an iterator to the past-the-end of the metadata list. 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...

SimpleRefCount &	operator= (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...

Private Attributes
DataCalculatorList	m_calcList
	List of data calculators. More...

std::string	m_description
	Description label. More...

std::string	m_experimentLabel
	Experiment label. More...

std::string	m_inputLabel
	Input label. More...

MetadataList	m_metadata
	List of experiment metadata. More...

std::string	m_runLabel
	Run label. More...

std::string	m_strategyLabel
	Strategy label. 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

Collects data.

Definition at line 49 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 )

Add a DataCalculator object to the DataCollector.

Parameters

datac DataCalculator object to be added

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

References m_calcList.

Referenced by main().

Here is the caller graph for this function:

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

Add the key and the value as a pair of strings to the metadata list.

Parameters

key	Key value to include
value	Value to include of type string

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

References m_metadata.

Referenced by main().

Here is the caller graph for this function:

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

Add the key and the value as a pair of strings to the metadata list.

Parameters

key	Key value to include
value	Value to include of type double

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

References m_metadata.

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

Add the key and the value as a pair of strings to the metadata list.

Parameters

key	Key value to include
value	Value to include of type uint32_t

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

References m_metadata.

DataCalculatorList::iterator DataCollector::DataCalculatorBegin ( )

Returns an iterator to the beginning of the DataCalculator list.

Returns: Iterator pointing to the first value of the DataCalculator list

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

Returns an iterator to the past-the-end of the DataCalculator list.

Returns: Iterator pointing to the past-the-end element of the DataCalculator list

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 = `""`
	)

Provide specific parameters to the DataCollector.

Parameters

experiment	Label for the experiment
strategy	Label for the strategy
input	Label for the input
runID	Label for the runID
description	Description

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

References experiment(), m_description, m_experimentLabel, m_inputLabel, m_runLabel, and m_strategyLabel.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

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 ns3::Object::DoDispose(), m_calcList, m_metadata, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function: