A stat for collecting packet size statistics: min, max and average. More...

#include "packet-data-calculators.h"

Inheritance diagram for ns3::PacketSizeMinMaxAvgTotalCalculator:

Collaboration diagram for ns3::PacketSizeMinMaxAvgTotalCalculator:

Public Member Functions
	PacketSizeMinMaxAvgTotalCalculator ()

	~PacketSizeMinMaxAvgTotalCalculator () override

void	FrameUpdate (std::string path, Ptr< const Packet > packet, Mac48Address realto)
	Increments the packet stats by the size of the packet.

void	PacketUpdate (std::string path, Ptr< const Packet > packet)
	Increments the packet stats by the size of the packet.

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

virtual void	Output (DataOutputCallback &callback) const =0
	Outputs data based on the provided callback.

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 override
	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.

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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.

virtual long	getCount () const =0
	Returns the number of observations.

virtual double	getMax () const =0
	Returns the maximum of the values.

virtual double	getMean () const =0
	Returns the mean of the (weighted) observations.

virtual double	getMin () const =0
	Returns the minimum of the values.

virtual double	getSqrSum () const =0

virtual double	getStddev () const =0
	Returns the standard deviation of the (weighted) observations.

virtual double	getSum () const =0

virtual double	getVariance () const =0
	Returns the variance of the (weighted) observations.

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

Static Public Member Functions inherited from ns3::MinMaxAvgTotalCalculator< uint32_t >
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
	Destructor implementation.

Protected Member Functions inherited from ns3::MinMaxAvgTotalCalculator< uint32_t >
void	DoDispose () override
	Dispose of this Object.

void	DoDispose () override
	Destructor implementation.

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

virtual void	DoDispose ()
	Destructor implementation.

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.

Additional Inherited Members
Protected Attributes inherited from ns3::MinMaxAvgTotalCalculator< uint32_t >
uint32_t	m_count
	Count value of MinMaxAvgTotalCalculator.

uint32_t	m_max
	Maximum value of MinMaxAvgTotalCalculator.

double	m_meanCurr
	Current mean of MinMaxAvgTotalCalculator.

double	m_meanPrev
	Previous mean of MinMaxAvgTotalCalculator.

uint32_t	m_min
	Minimum value of MinMaxAvgTotalCalculator.

double	m_sCurr
	Current s of MinMaxAvgTotalCalculator.

double	m_sPrev
	Previous s of MinMaxAvgTotalCalculator.

uint32_t	m_squareTotal
	Sum of squares value of MinMaxAvgTotalCalculator.

uint32_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.

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

Detailed Description

A stat for collecting packet size statistics: min, max and average.

Definition at line 82 of file packet-data-calculators.h.

Constructor & Destructor Documentation

◆ PacketSizeMinMaxAvgTotalCalculator()

PacketSizeMinMaxAvgTotalCalculator::PacketSizeMinMaxAvgTotalCalculator ( )

Definition at line 87 of file packet-data-calculators.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~PacketSizeMinMaxAvgTotalCalculator()

PacketSizeMinMaxAvgTotalCalculator::~PacketSizeMinMaxAvgTotalCalculator ( )

override

Definition at line 92 of file packet-data-calculators.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void PacketSizeMinMaxAvgTotalCalculator::DoDispose ( )

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::Object.

Definition at line 109 of file packet-data-calculators.cc.

References ns3::MinMaxAvgTotalCalculator< T >::DoDispose(), and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function: