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::Probe Class Referenceabstract

#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)
 
void Enable (void)
 Set the status of an individual object. More...
 
std::string GetName (void) const
 Get the object's name. 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)
 
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 ()
 
- Static Public Member Functions inherited from ns3::DataCollectionObject
static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Base class for probes.

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

Doxygen introspection did not find any typical Config paths.

Attributes

  • Start: Time data collection starts
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +0.0ns
    • Flags: construct write read
  • Stop: Time when data collection stops. The special time value of 0 disables this attribute
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +0.0ns
    • Flags: construct write read

Attributes defined in parent class ns3::DataCollectionObject

  • 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 37 of file probe.h.

Constructor & Destructor Documentation

ns3::Probe::Probe ( )

Definition at line 52 of file probe.cc.

References NS_LOG_FUNCTION.

ns3::Probe::~Probe ( )
virtual

Definition at line 57 of file probe.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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::Ipv6PacketProbe, ns3::ApplicationPacketProbe, ns3::Ipv4PacketProbe, ns3::BooleanProbe, ns3::DoubleProbe, ns3::PacketProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.

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::Ipv6PacketProbe, ns3::ApplicationPacketProbe, ns3::Ipv4PacketProbe, ns3::BooleanProbe, ns3::DoubleProbe, ns3::PacketProbe, ns3::Uinteger16Probe, ns3::Uinteger32Probe, and ns3::Uinteger8Probe.

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

Definition at line 34 of file probe.cc.

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

+ Here is the call graph for this function:

bool ns3::Probe::IsEnabled ( void  ) const
virtual
Returns
true if Probe is currently enabled

Reimplemented from ns3::DataCollectionObject.

Definition at line 63 of file probe.cc.

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

Time ns3::Probe::m_start
protected

Time when logging starts.

Definition at line 70 of file probe.h.

Referenced by GetTypeId(), and IsEnabled().

Time ns3::Probe::m_stop
protected

Time when logging stops.

Definition at line 73 of file probe.h.

Referenced by GetTypeId(), and IsEnabled().

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