Base class for data collection framework objects. More...
#include <data-collection-object.h>
Public Member Functions | |
DataCollectionObject () | |
virtual | ~DataCollectionObject () |
void | Disable (void) |
Unset the status of an individual object. More... | |
void | Enable (void) |
Set the status of an individual object. More... | |
std::string | GetName (void) const |
Get the object's name. More... | |
virtual bool | IsEnabled (void) const |
Check the status of an individual object. More... | |
void | SetName (std::string name) |
Set the object's name. All spaces are replaced by underscores. 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... | |
SimpleRefCount & | operator= (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) |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
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... | |
Protected Attributes | |
bool | m_enabled |
Object's activation state. More... | |
std::string | m_name |
Name of the object within the data collection framework. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
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... | |
Base class for data collection framework objects.
Doxygen introspection did not find any typical Config paths.
All data collection objects have 1) a string name, and 2) enabled or disabled status.
No TraceSources are defined for this type.
Definition at line 37 of file data-collection-object.h.
ns3::DataCollectionObject::DataCollectionObject | ( | ) |
Definition at line 50 of file data-collection-object.cc.
|
virtual |
Definition at line 54 of file data-collection-object.cc.
References NS_LOG_FUNCTION.
void ns3::DataCollectionObject::Disable | ( | void | ) |
Unset the status of an individual object.
Definition at line 91 of file data-collection-object.cc.
References m_enabled, and NS_LOG_FUNCTION.
void ns3::DataCollectionObject::Enable | ( | void | ) |
Set the status of an individual object.
Definition at line 84 of file data-collection-object.cc.
References m_enabled, and NS_LOG_FUNCTION.
std::string ns3::DataCollectionObject::GetName | ( | void | ) | const |
Get the object's name.
Definition at line 66 of file data-collection-object.cc.
References m_name.
Referenced by ProbeTestCase1::DoRun(), GetTypeId(), and main().
|
static |
Get the type ID.
Definition at line 35 of file data-collection-object.cc.
References GetName(), m_enabled, SetName(), and ns3::TypeId::SetParent().
|
virtual |
Check the status of an individual object.
Reimplemented in ns3::Probe.
Definition at line 60 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. All spaces are replaced by underscores.
Definition at line 72 of file data-collection-object.cc.
References m_name, and NS_LOG_FUNCTION.
Referenced by ProbeTestCase1::DoRun(), GetTypeId(), and main().
|
protected |
Object's activation state.
Definition at line 65 of file data-collection-object.h.
Referenced by Disable(), Enable(), GetTypeId(), IsEnabled(), ns3::FileAggregator::Write10d(), ns3::FileAggregator::Write1d(), ns3::GnuplotAggregator::Write2d(), ns3::FileAggregator::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 68 of file data-collection-object.h.