Template class MinMaxAvgTotalCalculator. More...

#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
	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 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 ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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 ()
	Destructor. More...

Protected Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Protected Attributes
uint32_t	m_count
	Count value of MinMaxAvgTotalCalculator. More...

T	m_max
	Maximum value of MinMaxAvgTotalCalculator. More...

double	m_meanCurr
	Current mean of MinMaxAvgTotalCalculator. More...

double	m_meanPrev
	Previous mean of MinMaxAvgTotalCalculator. More...

T	m_min
	Minimum value of MinMaxAvgTotalCalculator. More...

double	m_sCurr
	Current s of MinMaxAvgTotalCalculator. More...

double	m_sPrev
	Previous s of MinMaxAvgTotalCalculator. More...

T	m_squareTotal
	Sum of squares value of MinMaxAvgTotalCalculator. More...

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Detailed Description

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

Template class MinMaxAvgTotalCalculator.

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

Constructor & Destructor Documentation

template<typename T >

ns3::MinMaxAvgTotalCalculator< T >::MinMaxAvgTotalCalculator ( )

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

References ns3::NaN.

template<typename T >

ns3::MinMaxAvgTotalCalculator< T >::~MinMaxAvgTotalCalculator ( )

virtual

Definition at line 135 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 140 of file basic-data-calculators.h.

References ns3::DataCalculator::DoDispose().

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

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T = uint32_t>

long ns3::MinMaxAvgTotalCalculator< T >::getCount ( ) const

inlinevirtual

Returns the count.

Returns: Count

Implements ns3::StatisticalSummary.

Definition at line 60 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 value.

Returns: Max

Implements ns3::StatisticalSummary.

Definition at line 75 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 value.

Returns: Mean

Implements ns3::StatisticalSummary.

Definition at line 80 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 value.

Returns: Min

Implements ns3::StatisticalSummary.

Definition at line 70 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 squares.

Returns: Sum of squares

Implements ns3::StatisticalSummary.

Definition at line 95 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.

Returns: Standard deviation

Implements ns3::StatisticalSummary.

Definition at line 85 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.

Returns: Total

Implements ns3::StatisticalSummary.

Definition at line 65 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 current variance.

Returns: Variance

Implements ns3::StatisticalSummary.

Definition at line 90 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

Outputs data based on the provided callback.

Parameters

callback

Implements ns3::DataCalculator.

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

Reinitializes all variables of MinMaxAvgTotalCalculator.

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

Updates all variables of MinMaxAvgTotalCalculator.

Parameters

i	value of type T to use for updating the calculator

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

Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), FiveDoublesTestCase::DoRun(), ns3::PacketSizeMinMaxAvgTotalCalculator::FrameUpdate(), ns3::PacketSizeMinMaxAvgTotalCalculator::PacketUpdate(), 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

Count value of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_max

protected

Maximum value of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_meanCurr

protected

Current mean of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_meanPrev

protected

Previous mean of MinMaxAvgTotalCalculator.

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

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_min

protected

Minimum value of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_sCurr

protected

Current s of MinMaxAvgTotalCalculator.

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

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_sPrev

protected

Previous s of MinMaxAvgTotalCalculator.

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

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_squareTotal

protected

Sum of squares value of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_total

protected

Total value of MinMaxAvgTotalCalculator.

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

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

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_varianceCurr

protected

Current variance of MinMaxAvgTotalCalculator.

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

Referenced by ns3::MinMaxAvgTotalCalculator< uint64_t >::getStddev(), and ns3::MinMaxAvgTotalCalculator< uint64_t >::getVariance().

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

src/stats/model/basic-data-calculators.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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