A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ns3::MinMaxAvgTotalCalculator< T > Class Template Reference

Template class MinMaxAvgTotalCalculator. More...

#include "basic-data-calculators.h"

+ Inheritance diagram for ns3::MinMaxAvgTotalCalculator< T >:

Public Member Functions

 MinMaxAvgTotalCalculator ()
 
virtual ~MinMaxAvgTotalCalculator ()
 
long getCount () const
 Returns the count. More...
 
double getMax () const
 Returns the maximum value. More...
 
double getMean () const
 Returns the mean value. More...
 
double getMin () const
 Returns the minimum value. More...
 
double getSqrSum () const
 Returns the sum of squares. More...
 
double getStddev () const
 Returns the standard deviation. More...
 
double getSum () const
 Returns the sum. More...
 
double getVariance () const
 Returns the current variance. More...
 
virtual void Output (DataOutputCallback &callback) const
 Outputs the data based on the provided callback. More...
 
void Reset ()
 Reinitializes all variables of MinMaxAvgTotalCalculator. More...
 
void Update (const T i)
 Updates all variables of MinMaxAvgTotalCalculator. More...
 
- Public Member Functions inherited from ns3::DataCalculator
 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...
 
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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
- Public Member Functions inherited from ns3::StatisticalSummary
virtual ~StatisticalSummary ()
 Destructor. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::DataCalculator
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

uint32_t m_count
 Count value of MinMaxAvgTotalCalculator. More...
 
m_max
 Maximum value of MinMaxAvgTotalCalculator. More...
 
double m_meanCurr
 Current mean of MinMaxAvgTotalCalculator. More...
 
double m_meanPrev
 Previous mean of MinMaxAvgTotalCalculator. More...
 
m_min
 Minimum value of MinMaxAvgTotalCalculator. More...
 
double m_sCurr
 Current s of MinMaxAvgTotalCalculator. More...
 
double m_sPrev
 Previous s of MinMaxAvgTotalCalculator. More...
 
m_squareTotal
 Sum of squares value of MinMaxAvgTotalCalculator. More...
 
m_total
 Total value of MinMaxAvgTotalCalculator. More...
 
double m_varianceCurr
 Current variance of MinMaxAvgTotalCalculator. 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

template<typename T = uint32_t>
class ns3::MinMaxAvgTotalCalculator< T >

Template class MinMaxAvgTotalCalculator.

Definition at line 39 of file basic-data-calculators.h.

Constructor & Destructor Documentation

◆ MinMaxAvgTotalCalculator()

Definition at line 130 of file basic-data-calculators.h.

◆ ~MinMaxAvgTotalCalculator()

template<typename T >
ns3::MinMaxAvgTotalCalculator< T >::~MinMaxAvgTotalCalculator ( )
virtual

Definition at line 146 of file basic-data-calculators.h.

Member Function Documentation

◆ DoDispose()

template<typename T >
void ns3::MinMaxAvgTotalCalculator< T >::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::DataCalculator.

Reimplemented in ns3::PacketSizeMinMaxAvgTotalCalculator.

Definition at line 152 of file basic-data-calculators.h.

Referenced by ns3::PacketSizeMinMaxAvgTotalCalculator::DoDispose().

◆ getCount()

template<typename T = uint32_t>
long ns3::MinMaxAvgTotalCalculator< T >::getCount ( ) const
inlinevirtual

Returns the count.

Returns
Count

Implements ns3::StatisticalSummary.

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

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().

◆ getMax()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getMax ( ) const
inlinevirtual

◆ getMean()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getMean ( ) const
inlinevirtual

◆ getMin()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getMin ( ) const
inlinevirtual

◆ getSqrSum()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getSqrSum ( ) const
inlinevirtual

Returns the sum of squares.

Returns
Sum of squares

Implements ns3::StatisticalSummary.

Definition at line 106 of file basic-data-calculators.h.

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().

◆ getStddev()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getStddev ( ) const
inlinevirtual

Returns the standard deviation.

Returns
Standard deviation

Implements ns3::StatisticalSummary.

Definition at line 96 of file basic-data-calculators.h.

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().

◆ getSum()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getSum ( ) const
inlinevirtual

Returns the sum.

Returns
Total

Implements ns3::StatisticalSummary.

Definition at line 76 of file basic-data-calculators.h.

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().

◆ GetTypeId()

template<typename T >
TypeId ns3::MinMaxAvgTotalCalculator< T >::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 161 of file basic-data-calculators.h.

◆ getVariance()

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::getVariance ( ) const
inlinevirtual

Returns the current variance.

Returns
Variance

Implements ns3::StatisticalSummary.

Definition at line 101 of file basic-data-calculators.h.

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), FiveDoublesTestCase::DoRun(), and ns3::Average< double >::Var().

◆ Output()

template<typename T >
void ns3::MinMaxAvgTotalCalculator< T >::Output ( DataOutputCallback callback) const
virtual

Outputs the data based on the provided callback.

Parameters
callback

Implements ns3::DataCalculator.

Definition at line 253 of file basic-data-calculators.h.

◆ Reset()

template<typename T >
void ns3::MinMaxAvgTotalCalculator< T >::Reset ( void  )

Reinitializes all variables of MinMaxAvgTotalCalculator.

Definition at line 235 of file basic-data-calculators.h.

Referenced by ns3::Average< double >::Reset().

◆ Update()

template<typename T>
void ns3::MinMaxAvgTotalCalculator< T >::Update ( const T  i)

Member Data Documentation

◆ m_count

template<typename T = uint32_t>
uint32_t ns3::MinMaxAvgTotalCalculator< T >::m_count
protected

◆ m_max

template<typename T = uint32_t>
T ns3::MinMaxAvgTotalCalculator< T >::m_max
protected

◆ m_meanCurr

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::m_meanCurr
protected

◆ m_meanPrev

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::m_meanPrev
protected

Previous mean of MinMaxAvgTotalCalculator.

Definition at line 122 of file basic-data-calculators.h.

◆ m_min

template<typename T = uint32_t>
T ns3::MinMaxAvgTotalCalculator< T >::m_min
protected

◆ m_sCurr

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::m_sCurr
protected

Current s of MinMaxAvgTotalCalculator.

Definition at line 119 of file basic-data-calculators.h.

◆ m_sPrev

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::m_sPrev
protected

Previous s of MinMaxAvgTotalCalculator.

Definition at line 123 of file basic-data-calculators.h.

◆ m_squareTotal

template<typename T = uint32_t>
T ns3::MinMaxAvgTotalCalculator< T >::m_squareTotal
protected

Sum of squares value of MinMaxAvgTotalCalculator.

Definition at line 114 of file basic-data-calculators.h.

Referenced by ns3::MinMaxAvgTotalCalculator< uint64_t >::getSqrSum().

◆ m_total

template<typename T = uint32_t>
T ns3::MinMaxAvgTotalCalculator< T >::m_total
protected

◆ m_varianceCurr

template<typename T = uint32_t>
double ns3::MinMaxAvgTotalCalculator< T >::m_varianceCurr
protected

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