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.

void	Start ()
	Start emission of data.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
void	Report ()
	Reports a new value and reschedules.

Private Attributes
double	aux
	Emitted value.

double	m_time
	Delta time between reschedules.

TracedValue< double >	m_trace
	Trace.

Ptr< ExponentialRandomVariable >	m_var
	Random value generator.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.

References ns3::CreateObject(), and m_var.

Here is the call graph for this function:

◆ ~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 ( )

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.

References aux.

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.

References aux, m_trace, m_var, and Reschedule().

Referenced by Reschedule().

Here is the call graph for this function:

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, m_var, ns3::Simulator::Now(), Report(), ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by Report(), and Start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Start()

void SampleEmitter::Start ( )

inline

Start emission of data.

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

References Reschedule().

Referenced by ProbeTestCase1::DoRun().

Here is the call graph for this function:

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.

Referenced by GetValue(), and Report().

◆ m_time

double SampleEmitter::m_time

private

Delta time between reschedules.

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

Referenced by GetTime(), and Reschedule().

◆ m_trace

TracedValue<double> SampleEmitter::m_trace

private

Trace.

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

Referenced by GetTypeId(), and Report().

◆ m_var

Ptr<ExponentialRandomVariable> SampleEmitter::m_var

private

Random value generator.

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

Referenced by SampleEmitter(), Report(), and Reschedule().

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

src/stats/test/double-probe-test-suite.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SampleEmitter()

◆ ~SampleEmitter()

Member Function Documentation

◆ GetTime()

◆ GetTypeId()

◆ GetValue()

◆ Report()

◆ Reschedule()

◆ Start()

Member Data Documentation

◆ aux

◆ m_time

◆ m_trace

◆ m_var