A Discrete-Event Network Simulator
API
ns3::TimeMinMaxAvgTotalCalculator Class Reference

Unfortunately, templating the base MinMaxAvgTotalCalculator to operate over Time values isn't straightforward. More...

#include "time-data-calculators.h"

+ Inheritance diagram for ns3::TimeMinMaxAvgTotalCalculator:
+ Collaboration diagram for ns3::TimeMinMaxAvgTotalCalculator:

Public Member Functions

 TimeMinMaxAvgTotalCalculator ()
 
 ~TimeMinMaxAvgTotalCalculator () override
 
void Output (DataOutputCallback &callback) const override
 Outputs data based on the provided callback. More...
 
void Update (const Time i)
 Updates all variables of TimeMinMaxAvgTotalCalculator. More...
 
- Public Member Functions inherited from ns3::DataCalculator
 DataCalculator ()
 
 ~DataCalculator () override
 
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...
 
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...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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 () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::DataCalculator
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

uint32_t m_count
 Count value of TimeMinMaxAvgTotalCalculator. More...
 
Time m_max
 Maximum value of TimeMinMaxAvgTotalCalculator. More...
 
Time m_min
 Minimum value of TimeMinMaxAvgTotalCalculator. More...
 
Time m_total
 Total value of TimeMinMaxAvgTotalCalculator. More...
 
- Protected Attributes inherited from ns3::DataCalculator
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...
 

Additional Inherited Members

Detailed Description

Unfortunately, templating the base MinMaxAvgTotalCalculator to operate over Time values isn't straightforward.

The main issues are setting the maximum value, which can be worked around easily as it done here, and dividing to get the average, which is not as easily worked around.

Definition at line 42 of file time-data-calculators.h.

Constructor & Destructor Documentation

◆ TimeMinMaxAvgTotalCalculator()

TimeMinMaxAvgTotalCalculator::TimeMinMaxAvgTotalCalculator ( )

Definition at line 31 of file time-data-calculators.cc.

References m_count, and NS_LOG_FUNCTION.

◆ ~TimeMinMaxAvgTotalCalculator()

TimeMinMaxAvgTotalCalculator::~TimeMinMaxAvgTotalCalculator ( )
override

Definition at line 38 of file time-data-calculators.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void TimeMinMaxAvgTotalCalculator::DoDispose ( void  )
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::DataCalculator.

Definition at line 55 of file time-data-calculators.cc.

References ns3::DataCalculator::DoDispose(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId TimeMinMaxAvgTotalCalculator::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 45 of file time-data-calculators.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Output()

void TimeMinMaxAvgTotalCalculator::Output ( DataOutputCallback callback) const
overridevirtual

Outputs data based on the provided callback.

Parameters
callback

Implements ns3::DataCalculator.

Definition at line 96 of file time-data-calculators.cc.

References ns3::DataCalculator::m_context, m_count, ns3::DataCalculator::m_key, m_max, m_min, m_total, NS_LOG_FUNCTION, and ns3::DataOutputCallback::OutputSingleton().

+ Here is the call graph for this function:

◆ Update()

void TimeMinMaxAvgTotalCalculator::Update ( const Time  i)

Updates all variables of TimeMinMaxAvgTotalCalculator.

Parameters
ivalue of type Time to use for updating the calculator

Definition at line 64 of file time-data-calculators.cc.

References m_count, ns3::DataCalculator::m_enabled, m_max, m_min, m_total, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_count

uint32_t ns3::TimeMinMaxAvgTotalCalculator::m_count
protected

Count value of TimeMinMaxAvgTotalCalculator.

Definition at line 69 of file time-data-calculators.h.

Referenced by TimeMinMaxAvgTotalCalculator(), Output(), and Update().

◆ m_max

Time ns3::TimeMinMaxAvgTotalCalculator::m_max
protected

Maximum value of TimeMinMaxAvgTotalCalculator.

Definition at line 72 of file time-data-calculators.h.

Referenced by Output(), and Update().

◆ m_min

Time ns3::TimeMinMaxAvgTotalCalculator::m_min
protected

Minimum value of TimeMinMaxAvgTotalCalculator.

Definition at line 71 of file time-data-calculators.h.

Referenced by Output(), and Update().

◆ m_total

Time ns3::TimeMinMaxAvgTotalCalculator::m_total
protected

Total value of TimeMinMaxAvgTotalCalculator.

Definition at line 70 of file time-data-calculators.h.

Referenced by Output(), and Update().


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