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

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 Member Functions

 TimeSeriesAdaptor ()
 
virtual ~TimeSeriesAdaptor ()
 
void TraceSinkBoolean (bool oldData, bool newData)
 Trace sink for receiving data from bool valued trace sources. More...
 
void TraceSinkDouble (double oldData, double newData)
 Trace sink for receiving data from double valued trace sources. More...
 
void TraceSinkUinteger16 (uint16_t oldData, uint16_t newData)
 Trace sink for receiving data from uint16_t valued trace sources. More...
 
void TraceSinkUinteger32 (uint32_t oldData, uint32_t newData)
 Trace sink for receiving data from uint32_t valued trace sources. More...
 
void TraceSinkUinteger8 (uint8_t oldData, uint8_t newData)
 Trace sink for receiving data from uint8_t valued trace sources. More...
 
- Public Member Functions inherited from ns3::DataCollectionObject
 DataCollectionObject ()
 
virtual ~DataCollectionObject ()
 
void Disable (void)
 Unset the status of an individual object. More...
 
void Enable (void)
 Set the status of an individual object. More...
 
std::string GetName (void) const
 Get the object's name. More...
 
virtual bool IsEnabled (void) const
 Check the status of an individual object. More...
 
void SetName (std::string name)
 Set the object's name. All spaces are replaced by underscores. 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)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::DataCollectionObject
static TypeId GetTypeId ()
 Get the type ID. More...
 
- 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...
 

Private Attributes

TracedCallback< double, double > m_output
 output trace More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
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 inherited from ns3::DataCollectionObject
bool m_enabled
 Object's activation state. More...
 
std::string m_name
 Name of the object within the data collection framework. More...
 

Detailed Description

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

Doxygen introspection did not find any typical Config paths.

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.


No Attributes are defined for this type.

TraceSources

  • Output: The current simulation time versus the current value converted to a double

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

Constructor & Destructor Documentation

ns3::TimeSeriesAdaptor::TimeSeriesAdaptor ( )

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

References NS_LOG_FUNCTION.

ns3::TimeSeriesAdaptor::~TimeSeriesAdaptor ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

TypeId ns3::TimeSeriesAdaptor::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

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

Trace sink for receiving data from bool valued trace sources.

Parameters
oldDatathe original value.
newDatathe new value.

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

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

References NS_LOG_FUNCTION, and TraceSinkDouble().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Trace sink for receiving data from double valued trace sources.

Parameters
oldDatathe original value.
newDatathe new value.

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

Definition at line 61 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::GnuplotHelper::ConnectProbeToAggregator(), ns3::FileHelper::ConnectProbeToAggregator(), TraceSinkBoolean(), TraceSinkUinteger16(), TraceSinkUinteger32(), and TraceSinkUinteger8().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Trace sink for receiving data from uint16_t valued trace sources.

Parameters
oldDatathe original value.
newDatathe new value.

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

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

References NS_LOG_FUNCTION, and TraceSinkDouble().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Trace sink for receiving data from uint32_t valued trace sources.

Parameters
oldDatathe original value.
newDatathe new value.

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

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

References NS_LOG_FUNCTION, and TraceSinkDouble().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Trace sink for receiving data from uint8_t valued trace sources.

Parameters
oldDatathe original value.
newDatathe new value.

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

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

References NS_LOG_FUNCTION, and TraceSinkDouble().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

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

output trace

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

Referenced by GetTypeId(), and TraceSinkDouble().


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