A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::TimeMinMaxAvgTotalCalculator Class Reference

#include <time-data-calculators.h>

+ Inheritance diagram for ns3::TimeMinMaxAvgTotalCalculator:
+ Collaboration diagram for ns3::TimeMinMaxAvgTotalCalculator:

Public Member Functions

 TimeMinMaxAvgTotalCalculator ()
virtual ~TimeMinMaxAvgTotalCalculator ()
virtual void Output (DataOutputCallback &callback) const
void Update (const Time i)
- Public Member Functions inherited from ns3::DataCalculator
 DataCalculator ()
virtual ~DataCalculator ()
void Disable ()
void Enable ()
std::string GetContext () const
bool GetEnabled () const
std::string GetKey () const
void SetContext (const std::string context)
void SetKey (const std::string key)
virtual void Start (const Time &startTime)
virtual void Stop (const Time &stopTime)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Protected Member Functions

virtual void DoDispose (void)

Protected Attributes

uint32_t m_count
Time m_max
Time m_min
Time m_total
- Protected Attributes inherited from ns3::DataCalculator
std::string m_context
bool m_enabled
std::string m_key

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.

Detailed Description

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 42 of file time-data-calculators.h.

Constructor & Destructor Documentation

TimeMinMaxAvgTotalCalculator::TimeMinMaxAvgTotalCalculator ( )

Definition at line 33 of file time-data-calculators.cc.

References m_count.

TimeMinMaxAvgTotalCalculator::~TimeMinMaxAvgTotalCalculator ( )
virtual

Definition at line 37 of file time-data-calculators.cc.

Member Function Documentation

void TimeMinMaxAvgTotalCalculator::DoDispose ( void  )
protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 41 of file time-data-calculators.cc.

void TimeMinMaxAvgTotalCalculator::Output ( DataOutputCallback callback) const
virtual

Implements ns3::DataCalculator.

Definition at line 71 of file time-data-calculators.cc.

References ns3::DataCalculator::m_context, m_count, ns3::DataCalculator::m_key, m_max, m_min, m_total, and ns3::DataOutputCallback::OutputSingleton().

+ Here is the call graph for this function:

void TimeMinMaxAvgTotalCalculator::Update ( const Time  i)

Definition at line 48 of file time-data-calculators.cc.

References m_count, ns3::DataCalculator::m_enabled, m_max, m_min, and m_total.

Member Data Documentation

uint32_t ns3::TimeMinMaxAvgTotalCalculator::m_count
protected

Definition at line 54 of file time-data-calculators.h.

Referenced by Output(), TimeMinMaxAvgTotalCalculator(), and Update().

Time ns3::TimeMinMaxAvgTotalCalculator::m_max
protected

Definition at line 55 of file time-data-calculators.h.

Referenced by Output(), and Update().

Time ns3::TimeMinMaxAvgTotalCalculator::m_min
protected

Definition at line 55 of file time-data-calculators.h.

Referenced by Output(), and Update().

Time ns3::TimeMinMaxAvgTotalCalculator::m_total
protected

Definition at line 55 of file time-data-calculators.h.

Referenced by Output(), and Update().


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