#include <uinteger-8-probe.h>
Public Member Functions | |
Uinteger8Probe () | |
virtual | ~Uinteger8Probe () |
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... | |
uint8_t | GetValue (void) const |
void | SetValue (uint8_t value) |
![]() | |
Probe () | |
virtual | ~Probe () |
virtual bool | IsEnabled (void) const |
![]() | |
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... | |
![]() | |
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) |
![]() | |
SimpleRefCount () | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
![]() | |
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 void | SetValueByPath (std::string path, uint8_t value) |
Set a probe value by its name in the Config system. More... | |
![]() | |
static TypeId | GetTypeId () |
![]() | |
static TypeId | GetTypeId () |
![]() | |
static TypeId | GetTypeId (void) |
![]() | |
static void | Cleanup (void) |
![]() | |
static TypeId | GetTypeId (void) |
Private Member Functions | |
void | TraceSink (uint8_t oldData, uint8_t newData) |
Method to connect to an underlying ns3::TraceSource of type uint8_t. More... | |
Private Attributes | |
TracedValue< uint8_t > | m_output |
Additional Inherited Members | |
![]() | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
![]() | |
Time | m_start |
Time when logging starts. More... | |
Time | m_stop |
Time when logging stops. More... | |
![]() | |
bool | m_enabled |
Object's activation state. More... | |
std::string | m_name |
Name of the object within the data collection framework. More... | |
This class is designed to probe an underlying ns3 TraceSource exporting an uint8_t. This probe exports a trace source "Output" of type uint8_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.
Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
Definition at line 41 of file uinteger-8-probe.h.
ns3::Uinteger8Probe::Uinteger8Probe | ( | ) |
Definition at line 49 of file uinteger-8-probe.cc.
References m_output, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 55 of file uinteger-8-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 83 of file uinteger-8-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 92 of file uinteger-8-probe.cc.
References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().
|
static |
Definition at line 37 of file uinteger-8-probe.cc.
References m_output, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
uint8_t ns3::Uinteger8Probe::GetValue | ( | void | ) | const |
Definition at line 61 of file uinteger-8-probe.cc.
References m_output, and NS_LOG_FUNCTION.
void ns3::Uinteger8Probe::SetValue | ( | uint8_t | value | ) |
value | set the traced uint8_t to a new value |
Definition at line 67 of file uinteger-8-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 uint8_t to a new value |
Definition at line 74 of file uinteger-8-probe.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
private |
Method to connect to an underlying ns3::TraceSource of type uint8_t.
oldData | previous value of the uint8_t |
newData | new value of the uint8_t |
Definition at line 100 of file uinteger-8-probe.cc.
References ns3::Probe::IsEnabled(), m_output, and NS_LOG_FUNCTION.
Referenced by ConnectByObject(), and ConnectByPath().
|
private |
Definition at line 96 of file uinteger-8-probe.h.
Referenced by GetTypeId(), GetValue(), SetValue(), TraceSink(), and Uinteger8Probe().