A Discrete-Event Network Simulator
API
ns3::Probe Class Referenceabstract

Base class for probes. More...

#include "probe.h"

+ Inheritance diagram for ns3::Probe:
+ Collaboration diagram for ns3::Probe:

Public Member Functions

 Probe ()
 
virtual ~Probe ()
 
virtual bool ConnectByObject (std::string traceSource, Ptr< Object > obj)=0
 connect to a trace source attribute provided by a given object More...
 
virtual void ConnectByPath (std::string path)=0
 connect to a trace source provided by a config path More...
 
virtual bool IsEnabled (void) const
 
- Public Member Functions inherited from ns3::DataCollectionObject
 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. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::DataCollectionObject
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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Attributes

Time m_start
 Time when logging starts. More...
 
Time m_stop
 Time when logging stops. More...
 
- Protected Attributes inherited from ns3::DataCollectionObject
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)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Base class for probes.

Introspection did not find any typical Config paths.

This class provides general functionality to control each probe and the data generated by it.


Attributes

  • Start: Time data collection starts
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: constructwriteread
  • Stop: Time when data collection stops. The special time value of 0 disables this attribute
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: constructwriteread

Attributes defined in parent class ns3::DataCollectionObject

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

No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 39 of file probe.h.

Constructor & Destructor Documentation

◆ Probe()

ns3::Probe::Probe ( )

Definition at line 53 of file probe.cc.

References NS_LOG_FUNCTION.

◆ ~Probe()

ns3::Probe::~Probe ( )
virtual

Definition at line 58 of file probe.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ConnectByObject()

virtual bool ns3::Probe::ConnectByObject ( std::string  traceSource,
Ptr< Object obj 
)
pure virtual

connect to a trace source attribute provided by a given object

Parameters
traceSourcethe name of the attribute TraceSource to connect to
objns3::Object to connect to
Returns
true if the trace source was successfully connected

Implemented in ns3::ApplicationPacketProbe, ns3::Ipv4PacketProbe, ns3::Ipv6PacketProbe, ns3::PacketProbe, ns3::BooleanProbe, ns3::DoubleProbe, ns3::TimeProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.

◆ ConnectByPath()

virtual void ns3::Probe::ConnectByPath ( std::string  path)
pure virtual

connect to a trace source provided by a config path

Parameters
pathConfig path to bind to

Note, if an invalid path is provided, the probe will not be connected to anything.

Implemented in ns3::ApplicationPacketProbe, ns3::Ipv4PacketProbe, ns3::Ipv6PacketProbe, ns3::PacketProbe, ns3::BooleanProbe, ns3::DoubleProbe, ns3::TimeProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file probe.cc.

References m_start, m_stop, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsEnabled()

Member Data Documentation

◆ m_start

Time ns3::Probe::m_start
protected

Time when logging starts.

Definition at line 76 of file probe.h.

Referenced by GetTypeId(), and IsEnabled().

◆ m_stop

Time ns3::Probe::m_stop
protected

Time when logging stops.

Definition at line 79 of file probe.h.

Referenced by GetTypeId(), and IsEnabled().


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