A Discrete-Event Network Simulator
API
SampleEmitter Class Reference

Simple data emitter to check that a probe receives data. More...

+ Inheritance diagram for SampleEmitter:
+ Collaboration diagram for SampleEmitter:

Public Member Functions

 SampleEmitter ()
 
 ~SampleEmitter () override
 
double GetTime () const
 
double GetValue () const
 
void Reschedule ()
 Reschedule a report. More...
 
void Start ()
 Start emission of data. 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< ObjectGetObject () 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< ObjectGetObject (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...
 
SimpleRefCountoperator= (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 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 Report ()
 Reports a new value and reschedules. More...
 

Private Attributes

double aux
 Emitted value. More...
 
double m_time
 Delta time between reschedules. More...
 
TracedValue< double > m_trace
 Trace. More...
 
Ptr< ExponentialRandomVariablem_var
 Random value generator. 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...
 

Detailed Description

Simple data emitter to check that a probe receives data.

Definition at line 21 of file double-probe-test-suite.cc.

Constructor & Destructor Documentation

◆ SampleEmitter()

SampleEmitter::SampleEmitter ( )
inline

Definition at line 30 of file double-probe-test-suite.cc.

◆ ~SampleEmitter()

SampleEmitter::~SampleEmitter ( )
inlineoverride

Definition at line 35 of file double-probe-test-suite.cc.

Member Function Documentation

◆ GetTime()

double SampleEmitter::GetTime ( ) const
inline
Returns
the time delta of the next report.

Definition at line 54 of file double-probe-test-suite.cc.

References m_time.

◆ GetTypeId()

TypeId SampleEmitter::GetTypeId ( void  )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 81 of file double-probe-test-suite.cc.

References m_trace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetValue()

double SampleEmitter::GetValue ( ) const
inline
Returns
a random variable, different for each reschedule.

Definition at line 60 of file double-probe-test-suite.cc.

Referenced by ProbeTestCase1::TraceSink().

+ Here is the caller graph for this function:

◆ Report()

void SampleEmitter::Report ( )
inlineprivate

Reports a new value and reschedules.

See also
Reschedule

Definition at line 67 of file double-probe-test-suite.cc.

Referenced by Reschedule().

+ Here is the caller graph for this function:

◆ Reschedule()

void SampleEmitter::Reschedule ( )
inline

Reschedule a report.

See also
Report

Definition at line 46 of file double-probe-test-suite.cc.

References ns3::Time::GetSeconds(), m_time, ns3::Simulator::Now(), Report(), ns3::Simulator::Schedule(), and ns3::Seconds().

+ Here is the call graph for this function:

◆ Start()

void SampleEmitter::Start ( )
inline

Start emission of data.

Definition at line 40 of file double-probe-test-suite.cc.

Referenced by ProbeTestCase1::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ aux

double SampleEmitter::aux
private

Emitted value.

Definition at line 77 of file double-probe-test-suite.cc.

◆ m_time

double SampleEmitter::m_time
private

Delta time between reschedules.

Definition at line 75 of file double-probe-test-suite.cc.

◆ m_trace

TracedValue<double> SampleEmitter::m_trace
private

Trace.

Definition at line 76 of file double-probe-test-suite.cc.

Referenced by GetTypeId().

◆ m_var

Ptr<ExponentialRandomVariable> SampleEmitter::m_var
private

Random value generator.

Definition at line 74 of file double-probe-test-suite.cc.


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