Calculates data during a simulation. More...

#include "data-calculator.h"

Inheritance diagram for ns3::DataCalculator:

Collaboration diagram for ns3::DataCalculator:

Public Member Functions
	DataCalculator ()

virtual	~DataCalculator ()

void	Disable ()
	Disables DataCalculator when simulation stops. More...

void	Enable ()
	Enables DataCalculator when simulation starts. More...

std::string	GetContext () const
	Gets the DataCalculator context. More...

bool	GetEnabled () const
	Returns whether the DataCalculator is enabled. More...

std::string	GetKey () const
	Gets the DataCalculator key. More...

virtual void	Output (DataOutputCallback &callback) const =0
	Outputs data based on the provided callback. More...

void	SetContext (const std::string context)
	Sets the DataCalculator context to the provided context. More...

void	SetKey (const std::string key)
	Sets the DataCalculator key to the provided key. More...

virtual void	Start (const Time &startTime)
	Starts DataCalculator at a given time in the simulation. More...

virtual void	Stop (const Time &stopTime)
	Stops DataCalculator at a given time in the simulation. More...

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

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

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

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

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

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

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId (void)
	Register this type. More...

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

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

Protected Member Functions
virtual void	DoDispose (void)
	Destructor implementation. More...

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

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

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

Protected Attributes
std::string	m_context
	Context value. More...

bool	m_enabled
	Descendant classes must check & respect m_enabled! More...

std::string	m_key
	Key value. More...

Private Attributes
EventId	m_startEvent
	Start event. More...

EventId	m_stopEvent
	Stop event. More...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Calculates data during a simulation.

Definition at line 111 of file data-calculator.h.

Constructor & Destructor Documentation

◆ DataCalculator()

DataCalculator::DataCalculator ( )

Definition at line 35 of file data-calculator.cc.

References NS_LOG_FUNCTION.

◆ ~DataCalculator()

DataCalculator::~DataCalculator ( )

virtual

Definition at line 41 of file data-calculator.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Disable()

void DataCalculator::Disable ( void )

Disables DataCalculator when simulation stops.

Definition at line 118 of file data-calculator.cc.

References m_enabled, and NS_LOG_FUNCTION.

Referenced by Stop().

Here is the caller graph for this function:

◆ DoDispose()

void DataCalculator::DoDispose ( void )

protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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.

Reimplemented in ns3::TimeMinMaxAvgTotalCalculator, ns3::CounterCalculator< T >, ns3::CounterCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint64_t >, ns3::PacketSizeMinMaxAvgTotalCalculator, and ns3::PacketCounterCalculator.

Definition at line 59 of file data-calculator.cc.

References ns3::Simulator::Cancel(), ns3::Object::DoDispose(), m_startEvent, m_stopEvent, and NS_LOG_FUNCTION.

Referenced by ns3::MinMaxAvgTotalCalculator< T >::DoDispose(), ns3::CounterCalculator< T >::DoDispose(), and ns3::TimeMinMaxAvgTotalCalculator::DoDispose().

Here is the call graph for this function: