Calculates data during a simulation. More...
#include "data-calculator.h"
Public Member Functions | |
DataCalculator () | |
~DataCalculator () override | |
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... | |
virtual void | Output (DataOutputCallback &callback) const =0 |
Outputs data based on the provided callback. 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 () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. More... | |
Protected Attributes | |
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... | |
Private Attributes | |
EventId | m_startEvent |
Start event. More... | |
EventId | m_stopEvent |
Stop event. More... | |
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. More... | |
Calculates data during a simulation.
Definition at line 117 of file data-calculator.h.
DataCalculator::DataCalculator | ( | ) |
Definition at line 34 of file data-calculator.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 40 of file data-calculator.cc.
References NS_LOG_FUNCTION.
void DataCalculator::Disable | ( | ) |
Disables DataCalculator when simulation stops.
Definition at line 116 of file data-calculator.cc.
References m_enabled, and NS_LOG_FUNCTION.
Referenced by Stop().
|
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::Object.
Reimplemented in ns3::TimeMinMaxAvgTotalCalculator, ns3::CounterCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< double >.
Definition at line 56 of file data-calculator.cc.
References ns3::Simulator::Cancel(), ns3::Object::DoDispose(), m_startEvent, m_stopEvent, and NS_LOG_FUNCTION.
Referenced by ns3::MinMaxAvgTotalCalculator< T >::DoDispose(), ns3::CounterCalculator< T >::DoDispose(), and ns3::TimeMinMaxAvgTotalCalculator::DoDispose().
void DataCalculator::Enable | ( | ) |
Enables DataCalculator when simulation starts.
Definition at line 107 of file data-calculator.cc.
References m_enabled, and NS_LOG_FUNCTION.
Referenced by Start().
std::string DataCalculator::GetContext | ( | ) | const |
Gets the DataCalculator context.
Definition at line 97 of file data-calculator.cc.
References m_context, and NS_LOG_FUNCTION.
bool DataCalculator::GetEnabled | ( | ) | const |
Returns whether the DataCalculator is enabled.
Definition at line 125 of file data-calculator.cc.
References m_enabled, and NS_LOG_FUNCTION.
std::string DataCalculator::GetKey | ( | void | ) | const |
Gets the DataCalculator key.
Definition at line 78 of file data-calculator.cc.
References m_key, and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 47 of file data-calculator.cc.
References ns3::TypeId::SetParent().
|
pure virtual |
Outputs data based on the provided callback.
callback |
Implemented in ns3::TimeMinMaxAvgTotalCalculator, ns3::CounterCalculator< T >, ns3::CounterCalculator< uint32_t >, ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< double >.
void DataCalculator::SetContext | ( | const std::string | context | ) |
Sets the DataCalculator context to the provided context.
context | Context value as a string |
Definition at line 88 of file data-calculator.cc.
References m_context, and NS_LOG_FUNCTION.
void DataCalculator::SetKey | ( | const std::string | key | ) |
Sets the DataCalculator key to the provided key.
key | Key value as a string |
Definition at line 69 of file data-calculator.cc.
References m_key, and NS_LOG_FUNCTION.
|
virtual |
Starts DataCalculator at a given time in the simulation.
startTime |
Definition at line 135 of file data-calculator.cc.
References Enable(), m_startEvent, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().
|
virtual |
Stops DataCalculator at a given time in the simulation.
stopTime |
Definition at line 145 of file data-calculator.cc.
References Disable(), m_stopEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and stopTime.
|
protected |
Context value.
Definition at line 185 of file data-calculator.h.
Referenced by GetContext(), ns3::TimeMinMaxAvgTotalCalculator::Output(), and SetContext().
|
protected |
Descendant classes must check & respect m_enabled!
Definition at line 182 of file data-calculator.h.
Referenced by Disable(), Enable(), GetEnabled(), and ns3::TimeMinMaxAvgTotalCalculator::Update().
|
protected |
Key value.
Definition at line 184 of file data-calculator.h.
Referenced by GetKey(), ns3::TimeMinMaxAvgTotalCalculator::Output(), and SetKey().
|
private |
Start event.
Definition at line 190 of file data-calculator.h.
Referenced by DoDispose(), and Start().
|
private |
Stop event.
Definition at line 191 of file data-calculator.h.
Referenced by DoDispose(), and Stop().