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

Template class CounterCalculator. More...

#include <basic-data-calculators.h>

+ Inheritance diagram for ns3::CounterCalculator< T >:
+ Collaboration diagram for ns3::CounterCalculator< T >:

Public Member Functions

 CounterCalculator ()
 
virtual ~CounterCalculator ()
 
GetCount () const
 Returns the count of the CounterCalculator. More...
 
virtual void Output (DataOutputCallback &callback) const
 Outputs the data based on the provided callback. More...
 
void Update ()
 Increments count by 1. More...
 
void Update (const T i)
 Increments count by i. 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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 Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Protected Attributes

m_count
 Count value of CounterCalculator. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Detailed Description

template<typename T = uint32_t>
class ns3::CounterCalculator< T >

Template class CounterCalculator.

Definition at line 247 of file basic-data-calculators.h.

Constructor & Destructor Documentation

template<typename T >
ns3::CounterCalculator< T >::CounterCalculator ( )

Definition at line 285 of file basic-data-calculators.h.

template<typename T >
ns3::CounterCalculator< T >::~CounterCalculator ( )
virtual

Definition at line 291 of file basic-data-calculators.h.

Member Function Documentation

template<typename T >
void ns3::CounterCalculator< T >::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.

Reimplemented in ns3::PacketCounterCalculator.

Definition at line 296 of file basic-data-calculators.h.

References ns3::DataCalculator::DoDispose().

Referenced by ns3::PacketCounterCalculator::DoDispose().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename T >
T ns3::CounterCalculator< T >::GetCount ( ) const

Returns the count of the CounterCalculator.

Returns
Count as a value of type T

Definition at line 324 of file basic-data-calculators.h.

template<typename T >
void ns3::CounterCalculator< T >::Output ( DataOutputCallback callback) const
virtual

Outputs the data based on the provided callback.

Parameters
callback

Implements ns3::DataCalculator.

Definition at line 332 of file basic-data-calculators.h.

References ns3::DataOutputCallback::OutputSingleton().

+ Here is the call graph for this function:

template<typename T >
void ns3::CounterCalculator< T >::Update ( void  )

Increments count by 1.

Definition at line 304 of file basic-data-calculators.h.

Referenced by ns3::PacketCounterCalculator::FrameUpdate(), ns3::PacketCounterCalculator::PacketUpdate(), and Receiver::Receive().

+ Here is the caller graph for this function:

template<typename T>
void ns3::CounterCalculator< T >::Update ( const T  i)

Increments count by i.

Parameters
ivalue of type T to increment count

Definition at line 314 of file basic-data-calculators.h.

Member Data Documentation

template<typename T = uint32_t>
T ns3::CounterCalculator< T >::m_count
protected

Count value of CounterCalculator.

Definition at line 277 of file basic-data-calculators.h.


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