Takes probed values of different types and outputs the current time plus the value with both converted to doubles. More...

#include "time-series-adaptor.h"

Inheritance diagram for ns3::TimeSeriesAdaptor:

Collaboration diagram for ns3::TimeSeriesAdaptor:

Public Types
typedef void(*	OutputTracedCallback) (const double now, const double data)
	TracedCallback signature for output trace.

Public Member Functions
	TimeSeriesAdaptor ()

	~TimeSeriesAdaptor () override

void	TraceSinkBoolean (bool oldData, bool newData)
	Trace sink for receiving data from bool valued trace sources.

void	TraceSinkDouble (double oldData, double newData)
	Trace sink for receiving data from double valued trace sources.

void	TraceSinkUinteger16 (uint16_t oldData, uint16_t newData)
	Trace sink for receiving data from uint16_t valued trace sources.

void	TraceSinkUinteger32 (uint32_t oldData, uint32_t newData)
	Trace sink for receiving data from uint32_t valued trace sources.

void	TraceSinkUinteger8 (uint8_t oldData, uint8_t newData)
	Trace sink for receiving data from uint8_t valued trace sources.

Public Member Functions inherited from ns3::DataCollectionObject
	DataCollectionObject ()

	~DataCollectionObject () override

void	Disable ()
	Unset the status of an individual object.

void	Enable ()
	Set the status of an individual object.

std::string	GetName () const
	Get the object's name.

virtual bool	IsEnabled () const
	Check the status of an individual object.

void	SetName (std::string name)
	Set the object's name.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::DataCollectionObject
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
TracedCallback< double, double >	m_output
	output trace

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Protected Attributes inherited from ns3::DataCollectionObject
bool	m_enabled
	Object's activation state.

std::string	m_name
	Name of the object within the data collection framework.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Takes probed values of different types and outputs the current time plus the value with both converted to doubles.

The role of the TimeSeriesAdaptor class is that of an adaptor class, to take raw-valued probe data of different types, and output a tuple of two double values. The first is a timestamp which may be set to different resolutions (e.g. Seconds, Milliseconds, etc.) in the future, but which presently is hardcoded to Seconds. The second is the conversion of a non-double value to a double value (possibly with loss of precision).

It should be noted that time series adaptors convert Simulation Time objects to double values in its output.

Definition at line 38 of file time-series-adaptor.h.

Member Typedef Documentation

◆ OutputTracedCallback

typedef void(* ns3::TimeSeriesAdaptor::OutputTracedCallback) (const double now, const double data)

TracedCallback signature for output trace.

Parameters

[in]	now	The current time, in seconds.
[in]	data	The new data value.

Definition at line 111 of file time-series-adaptor.h.

Constructor & Destructor Documentation

◆ TimeSeriesAdaptor()

ns3::TimeSeriesAdaptor::TimeSeriesAdaptor ( )

Definition at line 41 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION.

◆ ~TimeSeriesAdaptor()

ns3::TimeSeriesAdaptor::~TimeSeriesAdaptor ( )

override

Definition at line 46 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::TimeSeriesAdaptor::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 27 of file time-series-adaptor.cc.

References m_output, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ TraceSinkBoolean()

void ns3::TimeSeriesAdaptor::TraceSinkBoolean	(	bool	oldData,
		bool	newData )

Trace sink for receiving data from bool valued trace sources.

Parameters

oldData	the original value.
newData	the new value.

This method serves as a trace sink to bool valued trace sources.

Definition at line 68 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION, and TraceSinkDouble().

Referenced by ns3::FileHelper::ConnectProbeToAggregator(), and ns3::GnuplotHelper::ConnectProbeToAggregator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceSinkDouble()

void ns3::TimeSeriesAdaptor::TraceSinkDouble	(	double	oldData,
		double	newData )

Trace sink for receiving data from double valued trace sources.

Parameters

oldData	the original value.
newData	the new value.

This method serves as a trace sink to double valued trace sources.

Definition at line 52 of file time-series-adaptor.cc.

References ns3::DataCollectionObject::IsEnabled(), m_output, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by ns3::FileHelper::ConnectProbeToAggregator(), ns3::GnuplotHelper::ConnectProbeToAggregator(), TraceSinkBoolean(), TraceSinkUinteger16(), TraceSinkUinteger32(), and TraceSinkUinteger8().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceSinkUinteger16()

void ns3::TimeSeriesAdaptor::TraceSinkUinteger16	(	uint16_t	oldData,
		uint16_t	newData )

Trace sink for receiving data from uint16_t valued trace sources.

Parameters

oldData	the original value.
newData	the new value.

This method serves as a trace sink to uint16_t valued trace sources.

Definition at line 86 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION, and TraceSinkDouble().

Referenced by ns3::FileHelper::ConnectProbeToAggregator(), and ns3::GnuplotHelper::ConnectProbeToAggregator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceSinkUinteger32()

void ns3::TimeSeriesAdaptor::TraceSinkUinteger32	(	uint32_t	oldData,
		uint32_t	newData )

Trace sink for receiving data from uint32_t valued trace sources.

Parameters

oldData	the original value.
newData	the new value.

This method serves as a trace sink to uint32_t valued trace sources.

Definition at line 95 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION, and TraceSinkDouble().

Referenced by ns3::FileHelper::ConnectProbeToAggregator(), and ns3::GnuplotHelper::ConnectProbeToAggregator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceSinkUinteger8()

void ns3::TimeSeriesAdaptor::TraceSinkUinteger8	(	uint8_t	oldData,
		uint8_t	newData )

Trace sink for receiving data from uint8_t valued trace sources.

Parameters

oldData	the original value.
newData	the new value.

This method serves as a trace sink to uint8_t valued trace sources.

Definition at line 77 of file time-series-adaptor.cc.

References NS_LOG_FUNCTION, and TraceSinkDouble().

Referenced by ns3::FileHelper::ConnectProbeToAggregator(), and ns3::GnuplotHelper::ConnectProbeToAggregator().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_output

TracedCallback<double, double> ns3::TimeSeriesAdaptor::m_output

private

output trace

Definition at line 114 of file time-series-adaptor.h.

Referenced by GetTypeId(), and TraceSinkDouble().

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

src/stats/model/time-series-adaptor.h
src/stats/model/time-series-adaptor.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ OutputTracedCallback

Constructor & Destructor Documentation

◆ TimeSeriesAdaptor()

◆ ~TimeSeriesAdaptor()

Member Function Documentation

◆ GetTypeId()

◆ TraceSinkBoolean()

◆ TraceSinkDouble()

◆ TraceSinkUinteger16()

◆ TraceSinkUinteger32()

◆ TraceSinkUinteger8()

Member Data Documentation

◆ m_output