Base class for probes. More...

#include "probe.h"

Inheritance diagram for ns3::Probe:

Collaboration diagram for ns3::Probe:

Public Member Functions
	Probe ()

	~Probe () override

virtual bool	ConnectByObject (std::string traceSource, Ptr< Object > obj)=0
	connect to a trace source attribute provided by a given object

virtual void	ConnectByPath (std::string path)=0
	connect to a trace source provided by a config path

bool	IsEnabled () const override

Public Member Functions inherited from ns3::DataCollectionObject
	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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::DataCollectionObject
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
Time	m_start
	Time when logging starts.

Time	m_stop
	Time when logging stops.

Protected Attributes inherited from ns3::DataCollectionObject
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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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

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

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

Definition at line 40 of file probe.h.

Constructor & Destructor Documentation

◆ Probe()

ns3::Probe::Probe ( )

Definition at line 54 of file probe.cc.

References NS_LOG_FUNCTION.

◆ ~Probe()

ns3::Probe::~Probe ( )

override

Definition at line 59 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

traceSource	the name of the attribute TraceSource to connect to
obj	ns3::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

path	Config 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 ( )

static

Get the type ID.

Returns: the object TypeId

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

bool ns3::Probe::IsEnabled ( ) const

overridevirtual

Returns: true if Probe is currently enabled

Reimplemented from ns3::DataCollectionObject.

Definition at line 65 of file probe.cc.

References ns3::DataCollectionObject::IsEnabled(), m_start, m_stop, ns3::Simulator::Now(), and ns3::Seconds().

Referenced by ns3::BooleanProbe::TraceSink(), ns3::DoubleProbe::TraceSink(), ns3::PacketProbe::TraceSink(), ns3::ApplicationPacketProbe::TraceSink(), ns3::Ipv4PacketProbe::TraceSink(), ns3::Ipv6PacketProbe::TraceSink(), ns3::TimeProbe::TraceSink(), ns3::Uinteger16Probe::TraceSink(), ns3::Uinteger32Probe::TraceSink(), and ns3::Uinteger8Probe::TraceSink().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_start

Time ns3::Probe::m_start

protected

Time when logging starts.

Definition at line 77 of file probe.h.

Referenced by GetTypeId(), and IsEnabled().

◆ m_stop

Time ns3::Probe::m_stop

protected

Time when logging stops.

Definition at line 80 of file probe.h.