This is our test object, an object that increments counters at various times and emits one of them as a trace source. More...

Inheritance diagram for Emitter:

Collaboration diagram for Emitter:

Public Member Functions
	Emitter ()

	Emitter ()

	Emitter ()

	Emitter ()

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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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 ()
	Register this type.

static TypeId	GetTypeId ()
	Register this type.

static TypeId	GetTypeId ()
	Register this type.

static TypeId	GetTypeId ()
	Register this type.

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	Count ()
	Counts how many times this function is called.

void	Count ()
	Counts how many time this function is called.

void	Count ()
	Counts how many time this function is called.

void	DoInitialize () override
	Initialize() implementation.

void	DoInitialize () override
	Initialize() implementation.

void	DoInitialize () override
	Initialize() implementation.

void	DoInitialize () override
	Initialize() implementation.

void	Emit ()
	Generate data - actually this function is not traced.

void	Emit ()
	Generate data.

Private Attributes
TracedValue< double >	m_counter
	Sample counter, normally this would be integer type.

TracedValue< uint32_t >	m_counter
	Simple counter.

TracedValue< Time >	m_interval
	Interarrival time between events.

Time	m_last
	Current interarrival time.

Ptr< ExponentialRandomVariable >	m_var
	Random number 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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

This is our test object, an object that increments counters at various times and emits one of them as a trace source.

This is our test object, an object that emits values according to a Poisson arrival process.

This is our test object, an object that increments a counter according to a Poisson process, and exports the (integer-valued) count as a trace source.

It emits a traced Time value as a trace source; this takes the value of interarrival time

Definition at line 37 of file double-probe-example.cc.

Constructor & Destructor Documentation

◆ Emitter() [1/4]

Emitter::Emitter ( )

Definition at line 75 of file double-probe-example.cc.

References m_counter, m_var, and NS_LOG_FUNCTION.

◆ Emitter() [2/4]

Emitter::Emitter ( )

◆ Emitter() [3/4]

Emitter::Emitter ( )

◆ Emitter() [4/4]

Emitter::Emitter ( )

Member Function Documentation

◆ Count() [1/3]

void Emitter::Count ( )

private

Counts how many times this function is called.

Definition at line 99 of file double-probe-example.cc.

References Count(), ns3::ExponentialRandomVariable::GetValue(), m_counter, m_var, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::DoubleProbe::SetValueByPath().

Referenced by Count(), and DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Count() [2/3]

void Emitter::Count ( )

private

Counts how many time this function is called.

◆ Count() [3/3]

void Emitter::Count ( )

private

Counts how many time this function is called.

◆ DoInitialize() [1/4]

void Emitter::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 83 of file double-probe-example.cc.

References Count(), Emit(), ns3::ExponentialRandomVariable::GetValue(), m_var, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Seconds().

Here is the call graph for this function:

◆ DoInitialize() [2/4]

void Emitter::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

◆ DoInitialize() [3/4]

void Emitter::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

◆ DoInitialize() [4/4]

void Emitter::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

◆ Emit() [1/2]

void Emitter::Emit ( )

private

Generate data - actually this function is not traced.

Definition at line 91 of file double-probe-example.cc.

References Emit(), ns3::ExponentialRandomVariable::GetValue(), m_var, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by DoInitialize(), and Emit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Emit() [2/2]

void Emitter::Emit ( )

private

Generate data.

◆ GetTypeId() [1/4]

TypeId Emitter::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 62 of file double-probe-example.cc.

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

Here is the call graph for this function:

◆ GetTypeId() [2/4]

static TypeId Emitter::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

◆ GetTypeId() [3/4]

static TypeId Emitter::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

◆ GetTypeId() [4/4]

static TypeId Emitter::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Member Data Documentation

◆ m_counter [1/2]

TracedValue< uint32_t > Emitter::m_counter

private

Sample counter, normally this would be integer type.

Simple counter.

Definition at line 55 of file double-probe-example.cc.

Referenced by Emitter(), Count(), and GetTypeId().

◆ m_counter [2/2]

TracedValue<uint32_t> Emitter::m_counter

private

Simple counter.

Definition at line 56 of file file-helper-example.cc.

◆ m_interval

TracedValue<Time> Emitter::m_interval

private

Interarrival time between events.

Definition at line 67 of file time-probe-example.cc.

◆ m_last

Time Emitter::m_last

private

Current interarrival time.

Definition at line 68 of file time-probe-example.cc.

◆ m_var

Ptr< ExponentialRandomVariable > Emitter::m_var

private

Random number generator.

Definition at line 56 of file double-probe-example.cc.

Referenced by Emitter(), Count(), DoInitialize(), and Emit().

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

src/stats/examples/double-probe-example.cc
src/stats/examples/file-helper-example.cc
src/stats/examples/gnuplot-helper-example.cc
src/stats/examples/time-probe-example.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Emitter() [1/4]

◆ Emitter() [2/4]

◆ Emitter() [3/4]

◆ Emitter() [4/4]

Member Function Documentation

◆ Count() [1/3]

◆ Count() [2/3]

◆ Count() [3/3]

◆ DoInitialize() [1/4]

◆ DoInitialize() [2/4]

◆ DoInitialize() [3/4]

◆ DoInitialize() [4/4]

◆ Emit() [1/2]

◆ Emit() [2/2]

◆ GetTypeId() [1/4]

◆ GetTypeId() [2/4]

◆ GetTypeId() [3/4]

◆ GetTypeId() [4/4]

Member Data Documentation

◆ m_counter [1/2]

◆ m_counter [2/2]

◆ m_interval

◆ m_last

◆ m_var