This class is designed to probe an underlying ns3 TraceSource exporting an uint32_t. More...
#include "uinteger-32-probe.h"
Public Member Functions | |
Uinteger32Probe () | |
virtual | ~Uinteger32Probe () |
virtual bool | ConnectByObject (std::string traceSource, Ptr< Object > obj) |
connect to a trace source attribute provided by a given object More... | |
virtual void | ConnectByPath (std::string path) |
connect to a trace source provided by a config path More... | |
uint32_t | GetValue (void) const |
void | SetValue (uint32_t value) |
Public Member Functions inherited from ns3::Probe | |
Probe () | |
virtual | ~Probe () |
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... | |
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< 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... | |
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[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= ([[maybe_unused]] 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... | |
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, uint32_t 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 (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
void | TraceSink (uint32_t oldData, uint32_t newData) |
Method to connect to an underlying ns3::TraceSource of type uint32_t. More... | |
Private Attributes | |
TracedValue< uint32_t > | 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 (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... | |
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 (void) |
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 an uint32_t.
Introspection did not find any typical Config paths.
This probe exports a trace source "Output" of type uint32_t. 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.
No Attributes are defined for this type.
Size of this type is 112 bytes (on a 64-bit architecture).
Definition at line 43 of file uinteger-32-probe.h.
ns3::Uinteger32Probe::Uinteger32Probe | ( | ) |
Definition at line 51 of file uinteger-32-probe.cc.
References m_output, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 57 of file uinteger-32-probe.cc.
References NS_LOG_FUNCTION.
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 85 of file uinteger-32-probe.cc.
References ns3::Names::FindPath(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectBase::TraceConnectWithoutContext(), and TraceSink().
|
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.
Implements ns3::Probe.
Definition at line 94 of file uinteger-32-probe.cc.
References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().
|
static |
Get the type ID.
Definition at line 37 of file uinteger-32-probe.cc.
References m_output, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
uint32_t ns3::Uinteger32Probe::GetValue | ( | void | ) | const |
Definition at line 63 of file uinteger-32-probe.cc.
References m_output, and NS_LOG_FUNCTION.
void ns3::Uinteger32Probe::SetValue | ( | uint32_t | value | ) |
value | set the traced uint32_t to a new value |
Definition at line 69 of file uinteger-32-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 uint32_t to a new value |
Definition at line 76 of file uinteger-32-probe.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
private |
Method to connect to an underlying ns3::TraceSource of type uint32_t.
oldData | previous value of the uint32_t |
newData | new value of the uint32_t |
Definition at line 102 of file uinteger-32-probe.cc.
References ns3::Probe::IsEnabled(), m_output, and NS_LOG_FUNCTION.
Referenced by ConnectByObject(), and ConnectByPath().
|
private |
Output trace source.
Definition at line 100 of file uinteger-32-probe.h.
Referenced by Uinteger32Probe(), GetTypeId(), GetValue(), SetValue(), and TraceSink().