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

#include <basic-data-calculators.h>

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

Public Member Functions

 MinMaxAvgTotalCalculator ()
virtual ~MinMaxAvgTotalCalculator ()
long getCount () const
double getMax () const
double getMean () const
double getMin () const
double getSqrSum () const
double getStddev () const
double getSum () const
double getVariance () const
virtual void Output (DataOutputCallback &callback) const
void Reset ()
void Update (const T i)
- Public Member Functions inherited from ns3::DataCalculator
 DataCalculator ()
virtual ~DataCalculator ()
void Disable ()
void Enable ()
std::string GetContext () const
bool GetEnabled () const
std::string GetKey () const
void SetContext (const std::string context)
void SetKey (const std::string key)
virtual void Start (const Time &startTime)
virtual void Stop (const Time &stopTime)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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)
- Public Member Functions inherited from ns3::StatisticalSummary
virtual ~StatisticalSummary ()

Protected Member Functions

virtual void DoDispose (void)

Protected Attributes

uint32_t m_count
m_max
double m_meanCurr
double m_meanPrev
m_min
double m_sCurr
double m_sPrev
m_squareTotal
m_total
double m_varianceCurr
- Protected Attributes inherited from ns3::DataCalculator
std::string m_context
bool m_enabled
std::string m_key

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.

Detailed Description

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

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

Constructor & Destructor Documentation

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

References ns3::NaN.

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

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

Member Function Documentation

template<typename T >
void ns3::MinMaxAvgTotalCalculator< T >::DoDispose ( void  )
protectedvirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 100 of file basic-data-calculators.h.

References ns3::DataCalculator::DoDispose().

+ Here is the call graph for this function:

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

Returns the number of the observations.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the maximum of the values.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the mean of the (weighted) observations.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the minimum of the values.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the sum of the squared values.

See Also
getWeightedSqrSum()

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the standard deviation of the (weighted) observations.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the sum of the values.

See Also
getWeightedSum()

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Returns the variance of the (weighted) observations.

Implements ns3::StatisticalSummary.

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

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

+ Here is the caller graph for this function:

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

Implements ns3::DataCalculator.

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

References ns3::DataOutputCallback::OutputStatistic().

+ Here is the call graph for this function:

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

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

References ns3::NaN.

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

+ Here is the caller graph for this function:

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

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

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

+ Here is the caller graph for this function:

Member Data Documentation

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

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

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

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

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

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

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

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