Base class for probes. More...
#include "probe.h"
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. | |
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::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 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 probes.
Introspection did not find any typical Config paths.
This class provides general functionality to control each probe and the data generated by it.
Time
-9.22337e+18ns:+9.22337e+18ns Time
-9.22337e+18ns:+9.22337e+18ns std::string
No TraceSources are defined for this type.
Group: Stats
Size of this type is 104 bytes (on a 64-bit architecture).
ns3::Probe::Probe | ( | ) |
Definition at line 43 of file probe.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 48 of file probe.cc.
References NS_LOG_FUNCTION.
|
pure virtual |
connect to a trace source attribute provided by a given object
traceSource | the name of the attribute TraceSource to connect to |
obj | ns3::Object to connect to |
Implemented in ns3::ApplicationPacketProbe, ns3::BooleanProbe, ns3::DoubleProbe, ns3::Ipv4PacketProbe, ns3::Ipv6PacketProbe, ns3::PacketProbe, ns3::TimeProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.
|
pure virtual |
connect to a trace source provided by a config path
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::BooleanProbe, ns3::DoubleProbe, ns3::Ipv4PacketProbe, ns3::Ipv6PacketProbe, ns3::PacketProbe, ns3::TimeProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.
|
static |
Get the type ID.
Definition at line 24 of file probe.cc.
References m_start, m_stop, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().
|
overridevirtual |
Reimplemented from ns3::DataCollectionObject.
Definition at line 54 of file probe.cc.
References ns3::DataCollectionObject::IsEnabled(), ns3::Time::IsZero(), m_start, m_stop, and ns3::Simulator::Now().
Referenced by ns3::ApplicationPacketProbe::TraceSink(), ns3::BooleanProbe::TraceSink(), ns3::DoubleProbe::TraceSink(), ns3::Ipv4PacketProbe::TraceSink(), ns3::Ipv6PacketProbe::TraceSink(), ns3::PacketProbe::TraceSink(), ns3::TimeProbe::TraceSink(), ns3::Uinteger16Probe::TraceSink(), ns3::Uinteger32Probe::TraceSink(), and ns3::Uinteger8Probe::TraceSink().
|
protected |
Time when logging starts.
Definition at line 66 of file probe.h.
Referenced by GetTypeId(), and IsEnabled().
|
protected |
Time when logging stops.
Definition at line 69 of file probe.h.
Referenced by GetTypeId(), and IsEnabled().