|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
This class is designed to probe an underlying ns3 TraceSource exporting a bool. More...
#include "boolean-probe.h"
Inheritance diagram for ns3::BooleanProbe: Collaboration diagram for ns3::BooleanProbe:Public Member Functions | |
| BooleanProbe () | |
| ~BooleanProbe () override | |
| bool | ConnectByObject (std::string traceSource, Ptr< Object > obj) override |
| connect to a trace source attribute provided by a given object More... | |
| void | ConnectByPath (std::string path) override |
| connect to a trace source provided by a config path More... | |
| bool | GetValue () const |
| void | SetValue (bool value) |
| Public Member Functions inherited from ns3::Probe | |
| Probe () | |
| ~Probe () override | |
| bool | IsEnabled () const override |
| Public Member Functions inherited from ns3::DataCollectionObject | |
| DataCollectionObject () | |
| ~DataCollectionObject () override | |
| void | Disable () |
| Unset the status of an individual object. More... | |
| void | Enable () |
| Set the status of an individual object. More... | |
| std::string | GetName () const |
| Get the object's name. More... | |
| void | SetName (std::string name) |
| Set the object's name. More... | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| Constructor. More... | |
| ~Object () override | |
| Destructor. More... | |
| void | AggregateObject (Ptr< Object > other) |
| Aggregate two Objects together. More... | |
| void | Dispose () |
| Dispose of this Object. More... | |
| AggregateIterator | GetAggregateIterator () const |
| Get an iterator to the Objects aggregated to this one. More... | |
| TypeId | GetInstanceTypeId () const override |
| Get the most derived TypeId for this Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject () const |
| Get a pointer to the requested aggregated Object. More... | |
| template<> | |
| Ptr< Object > | GetObject () 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< Object > | GetObject (TypeId tid) const |
| Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
| void | Initialize () |
| Invoke DoInitialize on all Objects aggregated to this one. More... | |
| bool | IsInitialized () 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[[maybe_unused]]) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount () const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
| Assignment operator. More... | |
| void | Ref () const |
| Increment the reference count. More... | |
| void | Unref () 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 errors. 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 void | SetValueByPath (std::string path, bool value) |
| Set a probe value by its name in the Config system. More... | |
| Static Public Member Functions inherited from ns3::Probe | |
| 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 () |
| Register this type. More... | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId () |
| Get the type ID. More... | |
Private Member Functions | |
| void | TraceSink (bool oldData, bool newData) |
| Method to connect to an underlying ns3::TraceSource of type bool. More... | |
Private Attributes | |
| TracedValue< bool > | m_output |
| Output trace source. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. More... | |
| virtual void | DoDispose () |
| Destructor implementation. More... | |
| virtual void | DoInitialize () |
| Initialize() implementation. More... | |
| virtual void | NotifyNewAggregate () |
| 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 () |
| Notifier called once the ObjectBase is fully constructed. More... | |
| Protected Attributes inherited from ns3::Probe | |
| 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... | |
| Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid () |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
This class is designed to probe an underlying ns3 TraceSource exporting a bool.
This probe exports a trace source "Output" of type bool. The Output trace source emits a value when either the trace source emits a new value, or when SetValue () is called.
The current value of the probe can be polled with the GetValue () method.
Definition at line 48 of file boolean-probe.h.
| ns3::BooleanProbe::BooleanProbe | ( | ) |
Definition at line 52 of file boolean-probe.cc.
References m_output, and NS_LOG_FUNCTION.
|
override |
Definition at line 58 of file boolean-probe.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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 |
Implements ns3::Probe.
Definition at line 87 of file boolean-probe.cc.
References ns3::Names::FindPath(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectBase::TraceConnectWithoutContext(), and TraceSink().
Here is the call graph for this function:
|
overridevirtual |
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.
Implements ns3::Probe.
Definition at line 98 of file boolean-probe.cc.
References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().
Here is the call graph for this function:
|
static |
Get the type ID.
Definition at line 39 of file boolean-probe.cc.
References m_output, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:| bool ns3::BooleanProbe::GetValue | ( | ) | const |
Definition at line 64 of file boolean-probe.cc.
References m_output, and NS_LOG_FUNCTION.
| void ns3::BooleanProbe::SetValue | ( | bool | value | ) |
| value | set the traced bool to a new value |
Definition at line 71 of file boolean-probe.cc.
References m_output, and NS_LOG_FUNCTION.
|
static |
Set a probe value by its name in the Config system.
| path | Config path to access the probe |
| value | set the traced bool to a new value |
Definition at line 78 of file boolean-probe.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
private |
Method to connect to an underlying ns3::TraceSource of type bool.
| oldData | previous value of the bool |
| newData | new value of the bool |
Definition at line 106 of file boolean-probe.cc.
References ns3::Probe::IsEnabled(), m_output, and NS_LOG_FUNCTION.
Referenced by ConnectByObject(), and ConnectByPath().
Here is the call graph for this function: Here is the caller graph for this function:
|
private |
Output trace source.
Definition at line 105 of file boolean-probe.h.
Referenced by BooleanProbe(), GetTypeId(), GetValue(), SetValue(), and TraceSink().
1.9.1 
