wns::probe::bus::PassThroughProbeBus Class Reference
[ProbeBusses]

The PassThroughProbeBus publishes all Measurements available. More...

#include <probe/bus/PassThroughProbeBus.hpp>

Inheritance diagram for wns::probe::bus::PassThroughProbeBus:

[legend]

Collaboration diagram for wns::probe::bus::PassThroughProbeBus:

[legend]

List of all members.

Public Member Functions
virtual bool	accepts (const wns::simulator::Time &, const IContext &)
	Called to determine if the ProbeBus would accept the measurement.
virtual void	onMeasurement (const wns::simulator::Time &, const double &, const IContext &)
	Called to actually process the measurement.
virtual void	output ()
	Called by the simulator to trigger periodical storage of measurement data.
	PassThroughProbeBus (const wns::pyconfig::View &)
	PassThroughProbeBus ()
virtual	~PassThroughProbeBus ()

---

Detailed Description

If you want to receive messages implement the ProbeBus Interface and use the startObserving method on the PassThroughProbeBus to receive measurements. You may also use existing general purpose implementations already available.

Author:

Daniel Bültmann <me@daniel-bueltmann.de>

Definition at line 46 of file PassThroughProbeBus.hpp.

---

Constructor & Destructor Documentation

PassThroughProbeBus::PassThroughProbeBus

(

)

Definition at line 38 of file PassThroughProbeBus.cpp.

PassThroughProbeBus::PassThroughProbeBus

(

const wns::pyconfig::View &

)

Definition at line 42 of file PassThroughProbeBus.cpp.

virtual wns::probe::bus::PassThroughProbeBus::~PassThroughProbeBus

(

)

[inline, virtual]

Definition at line 55 of file PassThroughProbeBus.hpp.

---

Member Function Documentation

bool PassThroughProbeBus::accepts	(	const wns::simulator::Time &	time,
		const IContext &	context
	)			[virtual]

Parameters:

	time	The current timestamp of the simulation
	context	The context of your measurement.

Implements wns::probe::bus::ProbeBus.

Definition at line 47 of file PassThroughProbeBus.cpp.

void PassThroughProbeBus::onMeasurement	(	const wns::simulator::Time &	time,
		const double &	measurement,
		const IContext &	context
	)			[virtual]

Parameters:

	time	The current timestamp of the simulation
	measurement	The measured value.
	context	The context of your measurement.

Implements wns::probe::bus::ProbeBus.

Definition at line 54 of file PassThroughProbeBus.cpp.

void PassThroughProbeBus::output

(

)

[virtual]

Implements wns::probe::bus::ProbeBus.

Definition at line 63 of file PassThroughProbeBus.cpp.

---

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

• framework/library/src/probe/bus/PassThroughProbeBus.hpp
• framework/library/src/probe/bus/PassThroughProbeBus.cpp