A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ns3::DataCollectionObject Class Reference

#include <data-collection-object.h>

+ Inheritance diagram for ns3::DataCollectionObject:
+ Collaboration diagram for ns3::DataCollectionObject:

Public Member Functions

 DataCollectionObject ()
virtual ~DataCollectionObject ()
void Disable (void)
void Enable (void)
 Set the status of an individual object.
std::string GetName (void) const
 Get the object's name.
virtual bool IsEnabled (void) const
 Check the status of an individual object.
void SetName (std::string name)
 Set the object's name. All spaces are replaced by underscores.
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
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)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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 ()

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)
virtual void DoDispose (void)
virtual void DoInitialize (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Base class for data collection framework objects.

All data collection objects have 1) a string name, and 2) enabled or disabled status.

Doxygen introspection did not find any typical Config paths.

Attributes

  • Name: Object's name
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: unnamed
    • Flags: construct write read
  • Enabled: Object's enabled status
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

No TraceSources are defined for this type.

Definition at line 35 of file data-collection-object.h.

Constructor & Destructor Documentation

ns3::DataCollectionObject::DataCollectionObject ( )

Definition at line 49 of file data-collection-object.cc.

ns3::DataCollectionObject::~DataCollectionObject ( )
virtual

Definition at line 53 of file data-collection-object.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::DataCollectionObject::Disable ( void  )

Definition at line 90 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 83 of file data-collection-object.cc.

References m_enabled, and NS_LOG_FUNCTION.

Referenced by ns3::FileHelper::AddAggregator(), ns3::FileHelper::AddTimeSeriesAdaptor(), ns3::GnuplotHelper::AddTimeSeriesAdaptor(), ns3::GnuplotHelper::ConstructAggregator(), anonymous_namespace{file-aggregator-example.cc}::CreateCommaSeparatedFile(), anonymous_namespace{file-aggregator-example.cc}::CreateSpaceSeparatedFile(), and ns3::FileHelper::GetAggregatorSingle().

+ Here is the caller graph for this function:

std::string ns3::DataCollectionObject::GetName ( void  ) const

Get the object's name.

Definition at line 65 of file data-collection-object.cc.

References m_name.

Referenced by ProbeTestCase1::DoRun(), GetTypeId(), and main().

+ Here is the caller graph for this function:

TypeId ns3::DataCollectionObject::GetTypeId ( void  )
static

Get the type ID.

Reimplemented from ns3::Object.

Reimplemented in ns3::ApplicationPacketProbe, ns3::Ipv6PacketProbe, ns3::Ipv4PacketProbe, ns3::PacketProbe, ns3::FileAggregator, ns3::GnuplotAggregator, ns3::TimeSeriesAdaptor, ns3::BooleanProbe, ns3::DoubleProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, ns3::Uinteger8Probe, and ns3::Probe.

Definition at line 34 of file data-collection-object.cc.

References GetName(), m_enabled, SetName(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

bool ns3::DataCollectionObject::IsEnabled ( void  ) const
virtual

Check the status of an individual object.

Reimplemented in ns3::Probe.

Definition at line 59 of file data-collection-object.cc.

References m_enabled.

Referenced by ns3::Probe::IsEnabled(), and ns3::TimeSeriesAdaptor::TraceSinkDouble().

+ Here is the caller graph for this function:

void ns3::DataCollectionObject::SetName ( std::string  name)

Set the object's name. All spaces are replaced by underscores.

Definition at line 71 of file data-collection-object.cc.

References m_name, and NS_LOG_FUNCTION.

Referenced by ProbeTestCase1::DoRun(), GetTypeId(), and main().

+ Here is the caller graph for this function:

Member Data Documentation

bool ns3::DataCollectionObject::m_enabled
protected

Object's activation state.

Definition at line 58 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().

std::string ns3::DataCollectionObject::m_name
protected

Name of the object within the data collection framework.

Definition at line 61 of file data-collection-object.h.

Referenced by GetName(), and SetName().

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