Unfortunately, templating the base MinMaxAvgTotalCalculator to operate over Time values isn't straightforward. More...
#include "time-data-calculators.h"
Public Member Functions | |
TimeMinMaxAvgTotalCalculator () | |
~TimeMinMaxAvgTotalCalculator () override | |
void | Output (DataOutputCallback &callback) const override |
Outputs data based on the provided callback. | |
void | Update (const Time i) |
Updates all variables of TimeMinMaxAvgTotalCalculator. | |
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 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. | |
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. | |
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 |
Destructor implementation. | |
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 TimeMinMaxAvgTotalCalculator. | |
Time | m_max |
Maximum value of TimeMinMaxAvgTotalCalculator. | |
Time | m_min |
Minimum value of TimeMinMaxAvgTotalCalculator. | |
Time | m_total |
Total value of TimeMinMaxAvgTotalCalculator. | |
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. | |
Unfortunately, templating the base MinMaxAvgTotalCalculator to operate over Time values isn't straightforward.
The main issues are setting the maximum value, which can be worked around easily as it done here, and dividing to get the average, which is not as easily worked around.
Definition at line 31 of file time-data-calculators.h.
TimeMinMaxAvgTotalCalculator::TimeMinMaxAvgTotalCalculator | ( | ) |
Definition at line 20 of file time-data-calculators.cc.
References m_count, and NS_LOG_FUNCTION.
|
override |
Definition at line 27 of file time-data-calculators.cc.
References NS_LOG_FUNCTION.
|
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::DataCalculator.
Definition at line 44 of file time-data-calculators.cc.
References ns3::DataCalculator::DoDispose(), and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 34 of file time-data-calculators.cc.
References ns3::TypeId::SetParent().
|
overridevirtual |
Outputs data based on the provided callback.
callback |
Implements ns3::DataCalculator.
Definition at line 85 of file time-data-calculators.cc.
References ns3::DataCalculator::m_context, m_count, ns3::DataCalculator::m_key, m_max, m_min, m_total, NS_LOG_FUNCTION, and ns3::DataOutputCallback::OutputSingleton().
void TimeMinMaxAvgTotalCalculator::Update | ( | const Time | i | ) |
Updates all variables of TimeMinMaxAvgTotalCalculator.
i | value of type Time to use for updating the calculator |
Definition at line 53 of file time-data-calculators.cc.
References m_count, ns3::DataCalculator::m_enabled, m_max, m_min, m_total, and NS_LOG_FUNCTION.
|
protected |
Count value of TimeMinMaxAvgTotalCalculator.
Definition at line 58 of file time-data-calculators.h.
Referenced by TimeMinMaxAvgTotalCalculator(), Output(), and Update().
|
protected |
Maximum value of TimeMinMaxAvgTotalCalculator.
Definition at line 61 of file time-data-calculators.h.
|
protected |
Minimum value of TimeMinMaxAvgTotalCalculator.
Definition at line 60 of file time-data-calculators.h.
|
protected |
Total value of TimeMinMaxAvgTotalCalculator.
Definition at line 59 of file time-data-calculators.h.