Calculates data during a simulation. More...

#include "data-calculator.h"

Inheritance diagram for ns3::DataCalculator:

Collaboration diagram for ns3::DataCalculator:

Public Member Functions
	DataCalculator ()

	~DataCalculator () override

void	Disable ()
	Disables DataCalculator when simulation stops.

void	Enable ()
	Enables DataCalculator when simulation starts.

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

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

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

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

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

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

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

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

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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 ()
	Register this type.

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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
std::string	m_context
	Context value.

bool	m_enabled
	Descendant classes must check & respect m_enabled!

std::string	m_key
	Key value.

Private Attributes
EventId	m_startEvent
	Start event.

EventId	m_stopEvent
	Stop event.

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

Detailed Description

Calculates data during a simulation.

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

Constructor & Destructor Documentation

◆ DataCalculator()

DataCalculator::DataCalculator ( )

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

References NS_LOG_FUNCTION.

◆ ~DataCalculator()

DataCalculator::~DataCalculator ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Disable()

void DataCalculator::Disable ( )

Disables DataCalculator when simulation stops.

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

overrideprotectedvirtual

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::MinMaxAvgTotalCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint64_t >, and ns3::TimeMinMaxAvgTotalCalculator.

Definition at line 56 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:

Here is the caller graph for this function:

◆ Enable()

void DataCalculator::Enable ( )

Enables DataCalculator when simulation starts.

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

References m_enabled, and NS_LOG_FUNCTION.

Referenced by Start().

Here is the caller graph for this function:

◆ GetContext()

std::string DataCalculator::GetContext ( ) const

Gets the DataCalculator context.

Returns: Context value as a string

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

References m_context, and NS_LOG_FUNCTION.

◆ GetEnabled()

bool DataCalculator::GetEnabled ( ) const

Returns whether the DataCalculator is enabled.

Returns: true if DataCalculator is enabled

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

References m_enabled, and NS_LOG_FUNCTION.

◆ GetKey()

std::string DataCalculator::GetKey ( ) const

Gets the DataCalculator key.

Returns: Key value as a string

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

References m_key, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId DataCalculator::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Output()

virtual void ns3::DataCalculator::Output ( DataOutputCallback & callback ) const

pure virtual

Outputs data based on the provided callback.

Parameters

callback

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint64_t >, ns3::CounterCalculator< T >, and ns3::TimeMinMaxAvgTotalCalculator.

◆ SetContext()

void DataCalculator::SetContext ( const std::string context )

Sets the DataCalculator context to the provided context.

Parameters

context Context value as a string

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

References m_context, and NS_LOG_FUNCTION.

◆ SetKey()

void DataCalculator::SetKey ( const std::string key )

Sets the DataCalculator key to the provided key.

Parameters

key	Key value as a string

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

References m_key, and NS_LOG_FUNCTION.

◆ Start()

void DataCalculator::Start ( const Time & startTime )

virtual

Starts DataCalculator at a given time in the simulation.

Parameters

startTime

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

References Enable(), m_startEvent, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Here is the call graph for this function:

◆ Stop()

void DataCalculator::Stop ( const Time & stopTime )

virtual

Stops DataCalculator at a given time in the simulation.

Parameters

stopTime

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

References Disable(), m_stopEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and stopTime.

Here is the call graph for this function:

Member Data Documentation

◆ m_context

std::string ns3::DataCalculator::m_context

protected

Context value.

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

Referenced by GetContext(), ns3::TimeMinMaxAvgTotalCalculator::Output(), and SetContext().

◆ m_enabled

bool ns3::DataCalculator::m_enabled

protected

Descendant classes must check & respect m_enabled!

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

Referenced by Disable(), Enable(), GetEnabled(), and ns3::TimeMinMaxAvgTotalCalculator::Update().

◆ m_key

std::string ns3::DataCalculator::m_key

protected

Key value.

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

Referenced by GetKey(), ns3::TimeMinMaxAvgTotalCalculator::Output(), and SetKey().

◆ m_startEvent

EventId ns3::DataCalculator::m_startEvent

private

Start event.

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

Referenced by DoDispose(), and Start().

◆ m_stopEvent

EventId ns3::DataCalculator::m_stopEvent

private

Stop event.

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

Referenced by DoDispose(), and Stop().

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

src/stats/model/data-calculator.h
src/stats/model/data-calculator.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataCalculator()

◆ ~DataCalculator()

Member Function Documentation

◆ Disable()

◆ DoDispose()

◆ Enable()

◆ GetContext()

◆ GetEnabled()

◆ GetKey()

◆ GetTypeId()

◆ Output()

◆ SetContext()

◆ SetKey()

◆ Start()

◆ Stop()

Member Data Documentation

◆ m_context

◆ m_enabled

◆ m_key

◆ m_startEvent

◆ m_stopEvent