A Discrete-Event Network Simulator
API
ns3::PacketSizeMinMaxAvgTotalCalculator Class Reference

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 ()
 
virtual ~PacketSizeMinMaxAvgTotalCalculator ()
 
void FrameUpdate (std::string path, Ptr< const Packet > packet, Mac48Address realto)
 Increments the packet stats by the size of the packet. More...
 
void PacketUpdate (std::string path, Ptr< const Packet > packet)
 Increments the packet stats by the size of the packet. More...
 
- Public Member Functions inherited from ns3::MinMaxAvgTotalCalculator< uint32_t >
 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 uint32_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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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...
 
virtual long getCount () const =0
 Returns the number of observations. More...
 
virtual double getMax () const =0
 Returns the maximum of the values. More...
 
virtual double getMean () const =0
 Returns the mean of the (weighted) observations. More...
 
virtual double getMin () const =0
 Returns the minimum of the values. More...
 
virtual double getSqrSum () const =0
 
virtual double getStddev () const =0
 Returns the standard deviation of the (weighted) observations. More...
 
virtual double getSum () const =0
 
virtual double getVariance () const =0
 Returns the variance of the (weighted) observations. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ns3::MinMaxAvgTotalCalculator< uint32_t >
uint32_t m_count
 Count value of MinMaxAvgTotalCalculator. More...
 
uint32_t m_max
 Maximum value of MinMaxAvgTotalCalculator. More...
 
double m_meanCurr
 Current mean of MinMaxAvgTotalCalculator. More...
 
double m_meanPrev
 Previous mean of MinMaxAvgTotalCalculator. More...
 
uint32_t m_min
 Minimum value of MinMaxAvgTotalCalculator. More...
 
double m_sCurr
 Current s of MinMaxAvgTotalCalculator. More...
 
double m_sPrev
 Previous s of MinMaxAvgTotalCalculator. More...
 
uint32_t m_squareTotal
 Sum of squares value of MinMaxAvgTotalCalculator. More...
 
uint32_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...
 

Detailed Description

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

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

Constructor & Destructor Documentation

◆ PacketSizeMinMaxAvgTotalCalculator()

PacketSizeMinMaxAvgTotalCalculator::PacketSizeMinMaxAvgTotalCalculator ( )

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

References NS_LOG_FUNCTION_NOARGS.

◆ ~PacketSizeMinMaxAvgTotalCalculator()

PacketSizeMinMaxAvgTotalCalculator::~PacketSizeMinMaxAvgTotalCalculator ( )
virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void PacketSizeMinMaxAvgTotalCalculator::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::MinMaxAvgTotalCalculator< uint32_t >.

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

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

+ Here is the call graph for this function:

◆ FrameUpdate()

void PacketSizeMinMaxAvgTotalCalculator::FrameUpdate ( std::string  path,
Ptr< const Packet packet,
Mac48Address  realto 
)

Increments the packet stats by the size of the packet.

Parameters
pathnot used in this method
packetpacket size used to update stats
realtonot used in this method

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

References ns3::Packet::GetSize(), NS_LOG_FUNCTION_NOARGS, and ns3::MinMaxAvgTotalCalculator< T >::Update().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId PacketSizeMinMaxAvgTotalCalculator::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ PacketUpdate()

void PacketSizeMinMaxAvgTotalCalculator::PacketUpdate ( std::string  path,
Ptr< const Packet packet 
)

Increments the packet stats by the size of the packet.

Parameters
pathnot used in this method
packetpacket size used to update stats

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

References ns3::Packet::GetSize(), NS_LOG_FUNCTION_NOARGS, and ns3::MinMaxAvgTotalCalculator< T >::Update().

+ Here is the call graph for this function:

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