Template class CounterCalculator. More...
#include "basic-data-calculators.h"
Public Member Functions | |
CounterCalculator () | |
~CounterCalculator () override | |
T | GetCount () const |
Returns the count of the CounterCalculator. | |
void | Output (DataOutputCallback &callback) const override |
Outputs the data based on the provided callback. | |
void | Update () |
Increments count by 1. | |
void | Update (const T i) |
Increments count by i. | |
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. | |
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 | |
T | m_count |
Count value of CounterCalculator. | |
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 CounterCalculator.
Definition at line 300 of file basic-data-calculators.h.
ns3::CounterCalculator< T >::CounterCalculator |
Definition at line 347 of file basic-data-calculators.h.
|
override |
Definition at line 353 of file basic-data-calculators.h.
|
overrideprotectedvirtual |
Dispose of this Object.
Reimplemented from ns3::Object.
Definition at line 371 of file basic-data-calculators.h.
References ns3::DataCalculator::DoDispose().
Referenced by ns3::PacketCounterCalculator::DoDispose().
T ns3::CounterCalculator< T >::GetCount |
Returns the count of the CounterCalculator.
Definition at line 401 of file basic-data-calculators.h.
|
static |
Register this type.
Definition at line 360 of file basic-data-calculators.h.
References ns3::TypeId::SetParent().
|
overridevirtual |
Outputs the data based on the provided callback.
callback |
Implements ns3::DataCalculator.
Definition at line 409 of file basic-data-calculators.h.
References ns3::DataOutputCallback::OutputSingleton().
void ns3::CounterCalculator< T >::Update |
Increments count by 1.
Definition at line 379 of file basic-data-calculators.h.
Referenced by ns3::PacketCounterCalculator::FrameUpdate(), and ns3::PacketCounterCalculator::PacketUpdate().
void ns3::CounterCalculator< T >::Update | ( | const T | i | ) |
Increments count by i.
i | value of type T to increment count |
Definition at line 390 of file basic-data-calculators.h.
|
protected |
Count value of CounterCalculator.
Definition at line 340 of file basic-data-calculators.h.