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

	~MinMaxAvgTotalCalculator () override

long	getCount () const override
	Returns the count.

double	getMax () const override
	Returns the maximum value.

double	getMean () const override
	Returns the mean value.

double	getMin () const override
	Returns the minimum value.

double	getSqrSum () const override
	Returns the sum of squares.

double	getStddev () const override
	Returns the standard deviation.

double	getSum () const override
	Returns the sum.

double	getVariance () const override
	Returns the current variance.

void	Output (DataOutputCallback &callback) const override
	Outputs the data based on the provided callback.

void	Reset ()
	Reinitializes all variables of MinMaxAvgTotalCalculator.

void	Update (const T i)
	Updates all variables of MinMaxAvgTotalCalculator.

Public Member Functions inherited from ns3::DataCalculator
	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.

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 final
	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, bool permissive=false) 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.

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.

Public Member Functions inherited from ns3::StatisticalSummary
virtual	~StatisticalSummary ()
	Destructor.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::DataCalculator
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
	Dispose of this Object.

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

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
uint32_t	m_count
	Count value of MinMaxAvgTotalCalculator.

T	m_max
	Maximum value of MinMaxAvgTotalCalculator.

double	m_meanCurr
	Current mean of MinMaxAvgTotalCalculator.

double	m_meanPrev
	Previous mean of MinMaxAvgTotalCalculator.

T	m_min
	Minimum value of MinMaxAvgTotalCalculator.

double	m_sCurr
	Current s of MinMaxAvgTotalCalculator.

double	m_sPrev
	Previous s of MinMaxAvgTotalCalculator.

T	m_squareTotal
	Sum of squares value of MinMaxAvgTotalCalculator.

T	m_total
	Total value of MinMaxAvgTotalCalculator.

double	m_varianceCurr
	Current variance of MinMaxAvgTotalCalculator.

Protected Attributes inherited from ns3::DataCalculator
std::string	m_context
	Context value.

bool	m_enabled
	Descendant classes must check & respect m_enabled!

std::string	m_key
	Key value.

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

Detailed Description

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

Template class MinMaxAvgTotalCalculator.

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

Constructor & Destructor Documentation

◆ MinMaxAvgTotalCalculator()

template<typename T>

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

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

References m_count, m_meanCurr, m_meanPrev, m_sCurr, m_sPrev, m_squareTotal, m_total, and m_varianceCurr.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~MinMaxAvgTotalCalculator()

template<typename T>

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

override

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

Member Function Documentation

◆ DoDispose()

template<typename T>

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

overrideprotectedvirtual

Dispose of this Object.

Reimplemented from ns3::DataCalculator.

Reimplemented in ns3::PacketSizeMinMaxAvgTotalCalculator.

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

◆ getCount()

template<typename T = uint32_t>

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

inlineoverridevirtual

Returns the count.

Returns: Count

Implements ns3::StatisticalSummary.

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

References m_count.

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

Here is the caller graph for this function:

◆ getMax()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getMax ( ) const

inlineoverridevirtual

Returns the maximum value.

Returns: Max

Implements ns3::StatisticalSummary.

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

References m_max.

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

Here is the caller graph for this function:

◆ getMean()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getMean ( ) const

inlineoverridevirtual

Returns the mean value.

Returns: Mean

Implements ns3::StatisticalSummary.

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

References m_meanCurr.

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

Here is the caller graph for this function:

◆ getMin()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getMin ( ) const

inlineoverridevirtual

Returns the minimum value.

Returns: Min

Implements ns3::StatisticalSummary.

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

References m_min.

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

Here is the caller graph for this function:

◆ getSqrSum()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getSqrSum ( ) const

inlineoverridevirtual

Returns the sum of squares.

Returns: Sum of squares

Implements ns3::StatisticalSummary.

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

References m_squareTotal.

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

Here is the caller graph for this function:

◆ getStddev()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getStddev ( ) const

inlineoverridevirtual

Returns the standard deviation.

Returns: Standard deviation

Implements ns3::StatisticalSummary.

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

References m_varianceCurr.

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

Here is the caller graph for this function:

◆ getSum()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getSum ( ) const

inlineoverridevirtual

Returns the sum.

Returns: Total

Implements ns3::StatisticalSummary.

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

References m_total.

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

Here is the caller graph for this function:

◆ GetTypeId()

template<typename T>

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

static

Register this type.

Returns: The TypeId.

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

References MinMaxAvgTotalCalculator(), ns3::TypeId::SetParent(), and ns3::TypeNameGet().

Here is the call graph for this function:

◆ getVariance()

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::getVariance ( ) const

inlineoverridevirtual

Returns the current variance.

Returns: Variance

Implements ns3::StatisticalSummary.

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

References m_varianceCurr.

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

Here is the caller graph for this function:

◆ Output()

template<typename T>

void ns3::MinMaxAvgTotalCalculator< T >::Output ( DataOutputCallback & callback ) const

overridevirtual

Outputs the data based on the provided callback.

Parameters

callback

Implements ns3::DataCalculator.

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

References ns3::DataCalculator::m_context, ns3::DataCalculator::m_key, and ns3::DataOutputCallback::OutputStatistic().

Here is the call graph for this function:

◆ Reset()

template<typename T>

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

Reinitializes all variables of MinMaxAvgTotalCalculator.

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

References m_count, m_meanCurr, m_meanPrev, m_sCurr, m_sPrev, m_squareTotal, m_total, and m_varianceCurr.

◆ Update()

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 196 of file basic-data-calculators.h.

References m_count, ns3::DataCalculator::m_enabled, m_max, m_meanCurr, m_meanPrev, m_min, m_sCurr, m_sPrev, m_squareTotal, m_total, and m_varianceCurr.

Referenced by FiveDoublesTestCase::DoRun(), FiveIntegersTestCase::DoRun(), OneIntegerTestCase::DoRun(), ns3::PacketSizeMinMaxAvgTotalCalculator::FrameUpdate(), and ns3::PacketSizeMinMaxAvgTotalCalculator::PacketUpdate().

Here is the caller graph for this function:

Member Data Documentation

◆ m_count

template<typename T = uint32_t>

uint32_t ns3::MinMaxAvgTotalCalculator< T >::m_count

protected

Count value of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), getCount(), Reset(), and Update().

◆ m_max

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_max

protected

Maximum value of MinMaxAvgTotalCalculator.

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

Referenced by getMax(), and Update().

◆ m_meanCurr

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_meanCurr

protected

Current mean of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), getMean(), Reset(), and Update().

◆ m_meanPrev

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_meanPrev

protected

Previous mean of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), Reset(), and Update().

◆ m_min

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_min

protected

Minimum value of MinMaxAvgTotalCalculator.

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

Referenced by getMin(), and Update().

◆ m_sCurr

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_sCurr

protected

Current s of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), Reset(), and Update().

◆ m_sPrev

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_sPrev

protected

Previous s of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), Reset(), and Update().

◆ m_squareTotal

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_squareTotal

protected

Sum of squares value of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), getSqrSum(), Reset(), and Update().

◆ m_total

template<typename T = uint32_t>

T ns3::MinMaxAvgTotalCalculator< T >::m_total

protected

Total value of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), getSum(), Reset(), and Update().

◆ m_varianceCurr

template<typename T = uint32_t>

double ns3::MinMaxAvgTotalCalculator< T >::m_varianceCurr

protected

Current variance of MinMaxAvgTotalCalculator.

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

Referenced by MinMaxAvgTotalCalculator(), getStddev(), getVariance(), Reset(), and Update().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MinMaxAvgTotalCalculator()

◆ ~MinMaxAvgTotalCalculator()

Member Function Documentation

◆ DoDispose()

◆ getCount()

◆ getMax()

◆ getMean()

◆ getMin()

◆ getSqrSum()

◆ getStddev()

◆ getSum()

◆ GetTypeId()

◆ getVariance()

◆ Output()

◆ Reset()

◆ Update()

Member Data Documentation

◆ m_count

◆ m_max

◆ m_meanCurr

◆ m_meanPrev

◆ m_min

◆ m_sCurr

◆ m_sPrev

◆ m_squareTotal

◆ m_total

◆ m_varianceCurr