Base class for data collection framework objects. More...
#include "data-collection-object.h"
Public Member Functions | |
DataCollectionObject () | |
~DataCollectionObject () override | |
void | Disable () |
Unset the status of an individual object. | |
void | Enable () |
Set the status of an individual object. | |
std::string | GetName () const |
Get the object's name. | |
virtual bool | IsEnabled () const |
Check the status of an individual object. | |
void | SetName (std::string name) |
Set the object's name. | |
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 () |
Get the type ID. | |
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 Attributes | |
bool | m_enabled |
Object's activation state. | |
std::string | m_name |
Name of the object within the data collection framework. | |
Additional Inherited Members | |
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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Base class for data collection framework objects.
Introspection did not find any typical Config paths.
All data collection objects have 1) a string name, and 2) enabled or disabled status.
std::string
No TraceSources are defined for this type.
Group: Stats
Size of this type is 88 bytes (on a 64-bit architecture).
Definition at line 27 of file data-collection-object.h.
ns3::DataCollectionObject::DataCollectionObject | ( | ) |
Definition at line 43 of file data-collection-object.cc.
|
override |
Definition at line 47 of file data-collection-object.cc.
References NS_LOG_FUNCTION.
void ns3::DataCollectionObject::Disable | ( | ) |
Unset the status of an individual object.
Definition at line 84 of file data-collection-object.cc.
References m_enabled, and NS_LOG_FUNCTION.
void ns3::DataCollectionObject::Enable | ( | ) |
Set the status of an individual object.
Definition at line 77 of file data-collection-object.cc.
References m_enabled, and NS_LOG_FUNCTION.
std::string ns3::DataCollectionObject::GetName | ( | ) | const |
Get the object's name.
Definition at line 59 of file data-collection-object.cc.
References m_name.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 23 of file data-collection-object.cc.
References GetName(), m_enabled, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), SetName(), and ns3::TypeId::SetParent().
|
virtual |
Check the status of an individual object.
Reimplemented in ns3::Probe.
Definition at line 53 of file data-collection-object.cc.
References m_enabled.
Referenced by ns3::Probe::IsEnabled(), and ns3::TimeSeriesAdaptor::TraceSinkDouble().
void ns3::DataCollectionObject::SetName | ( | std::string | name | ) |
Set the object's name.
name | the object's name |
Definition at line 65 of file data-collection-object.cc.
References m_name, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
protected |
Object's activation state.
Definition at line 64 of file data-collection-object.h.
Referenced by Disable(), Enable(), GetTypeId(), IsEnabled(), ns3::FileAggregator::Write10d(), ns3::FileAggregator::Write1d(), ns3::FileAggregator::Write2d(), ns3::GnuplotAggregator::Write2d(), ns3::GnuplotAggregator::Write2dDatasetEmptyLine(), ns3::GnuplotAggregator::Write2dWithXErrorDelta(), ns3::GnuplotAggregator::Write2dWithXYErrorDelta(), ns3::GnuplotAggregator::Write2dWithYErrorDelta(), ns3::FileAggregator::Write3d(), ns3::FileAggregator::Write4d(), ns3::FileAggregator::Write5d(), ns3::FileAggregator::Write6d(), ns3::FileAggregator::Write7d(), ns3::FileAggregator::Write8d(), and ns3::FileAggregator::Write9d().
|
protected |
Name of the object within the data collection framework.
Definition at line 67 of file data-collection-object.h.