Template class MinMaxAvgTotalCalculator. More...
#include "basic-data-calculators.h"
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. | |
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::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::DataCalculator | |
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. | |
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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Template class MinMaxAvgTotalCalculator.
Definition at line 40 of file basic-data-calculators.h.
ns3::MinMaxAvgTotalCalculator< T >::MinMaxAvgTotalCalculator |
Definition at line 165 of file basic-data-calculators.h.
References ns3::NaN.
|
override |
Definition at line 181 of file basic-data-calculators.h.
|
overrideprotectedvirtual |
Dispose of this Object.
Reimplemented from ns3::Object.
Definition at line 187 of file basic-data-calculators.h.
References ns3::DataCalculator::DoDispose().
Referenced by ns3::PacketSizeMinMaxAvgTotalCalculator::DoDispose().
|
inlineoverridevirtual |
Returns the count.
Implements ns3::StatisticalSummary.
Definition at line 72 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_count.
Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the maximum value.
Implements ns3::StatisticalSummary.
Definition at line 99 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_max.
Referenced by ThreeGppHttpObjectTestCase::DoRun(), OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the mean value.
Implements ns3::StatisticalSummary.
Definition at line 108 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_meanCurr.
Referenced by ns3::Average< T >::Avg(), ThreeGppHttpObjectTestCase::DoRun(), OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the minimum value.
Implements ns3::StatisticalSummary.
Definition at line 90 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_min.
Referenced by ThreeGppHttpObjectTestCase::DoRun(), OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the sum of squares.
Implements ns3::StatisticalSummary.
Definition at line 135 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_squareTotal.
Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the standard deviation.
Implements ns3::StatisticalSummary.
Definition at line 117 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_varianceCurr.
Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
inlineoverridevirtual |
Returns the sum.
Implements ns3::StatisticalSummary.
Definition at line 81 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_total.
Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), and FiveDoublesTestCase::DoRun().
|
static |
Register this type.
Definition at line 196 of file basic-data-calculators.h.
References ns3::TypeId::SetParent().
|
inlineoverridevirtual |
Returns the current variance.
Implements ns3::StatisticalSummary.
Definition at line 126 of file basic-data-calculators.h.
References ns3::MinMaxAvgTotalCalculator< T >::m_varianceCurr.
Referenced by OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), FiveDoublesTestCase::DoRun(), and ns3::Average< T >::Var().
|
overridevirtual |
Outputs the data based on the provided callback.
callback |
Implements ns3::DataCalculator.
Definition at line 286 of file basic-data-calculators.h.
References ns3::DataOutputCallback::OutputStatistic().
void ns3::MinMaxAvgTotalCalculator< T >::Reset |
Reinitializes all variables of MinMaxAvgTotalCalculator.
Definition at line 268 of file basic-data-calculators.h.
References ns3::NaN.
Referenced by ns3::Average< T >::Reset().
void ns3::MinMaxAvgTotalCalculator< T >::Update | ( | const T | i | ) |
Updates all variables of MinMaxAvgTotalCalculator.
i | value of type T to use for updating the calculator |
Definition at line 207 of file basic-data-calculators.h.
Referenced by ThreeGppHttpObjectTestCase::ClientRxDelayCallback(), ThreeGppHttpObjectTestCase::ClientRxRttCallback(), OneIntegerTestCase::DoRun(), FiveIntegersTestCase::DoRun(), FiveDoublesTestCase::DoRun(), ns3::PacketSizeMinMaxAvgTotalCalculator::FrameUpdate(), ns3::PacketSizeMinMaxAvgTotalCalculator::PacketUpdate(), and ns3::Average< T >::Update().
|
protected |
Count value of MinMaxAvgTotalCalculator.
Definition at line 146 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getCount().
|
protected |
Maximum value of MinMaxAvgTotalCalculator.
Definition at line 151 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getMax().
|
protected |
Current mean of MinMaxAvgTotalCalculator.
Definition at line 153 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getMean().
|
protected |
Previous mean of MinMaxAvgTotalCalculator.
Definition at line 157 of file basic-data-calculators.h.
|
protected |
Minimum value of MinMaxAvgTotalCalculator.
Definition at line 150 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getMin().
|
protected |
Current s of MinMaxAvgTotalCalculator.
Definition at line 154 of file basic-data-calculators.h.
|
protected |
Previous s of MinMaxAvgTotalCalculator.
Definition at line 158 of file basic-data-calculators.h.
|
protected |
Sum of squares value of MinMaxAvgTotalCalculator.
Definition at line 149 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getSqrSum().
|
protected |
Total value of MinMaxAvgTotalCalculator.
Definition at line 148 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getSum().
|
protected |
Current variance of MinMaxAvgTotalCalculator.
Definition at line 155 of file basic-data-calculators.h.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::getStddev(), and ns3::MinMaxAvgTotalCalculator< T >::getVariance().