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

ProbeBus derivate that wraps a ProbeText StatEval.

#include <probe/bus/TextProbeBus.hpp>

Inheritance diagram for wns::probe::bus::TextProbeBus:

[legend]

Collaboration diagram for wns::probe::bus::TextProbeBus:

[legend]

List of all members.

Public Member Functions
void	printText (std::ostream &theStream)
void	putText (std::string message)
	TextProbeBus (const wns::pyconfig::View &pyco)
virtual	~TextProbeBus ()
Implementation of wns::probe::bus::ProbeBus Interface
virtual bool	accepts (const wns::simulator::Time &, const IContext &reg)
	Called to determine if the ProbeBus would accept the measurement.
virtual void	onMeasurement (const wns::simulator::Time &, const double &aValue, const IContext &reg)
	Called to actually process the measurement.
virtual void	output ()
	Called by the simulator to trigger periodical storage of measurement data.
Private Attributes
std::string	description_
bool	isJSON_
std::string	jsonEntrySeparator_
std::string	key_
	Key to listen for.
std::list< std::string >	messages_
std::string	name_
int	numCalls_
std::string	outfileBase_
	basename to construct the output file names
std::string	outputPath_
	path for the output files
bool	prependSimTimeFlag_
int	simTimePrecision_
int	simTimeWidth_
int	skipInterval_
bool	writeHeader_
	Wether to write the file header.

---

Detailed Description

Definition at line 42 of file TextProbeBus.hpp.

---

Constructor & Destructor Documentation

TextProbeBus::TextProbeBus

(

const wns::pyconfig::View &

pyco

)

Definition at line 44 of file TextProbeBus.cpp.

TextProbeBus::~TextProbeBus

(

)

[virtual]

Definition at line 59 of file TextProbeBus.cpp.

---

Member Function Documentation

bool TextProbeBus::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 106 of file TextProbeBus.cpp.

void TextProbeBus::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 100 of file TextProbeBus.cpp.

void TextProbeBus::output

(

)

[virtual]

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

Definition at line 77 of file TextProbeBus.cpp.

void TextProbeBus::printText

(

std::ostream &

theStream

)

Definition at line 113 of file TextProbeBus.cpp.

void TextProbeBus::putText

(

std::string

message

)

Definition at line 187 of file TextProbeBus.cpp.

---

Member Data Documentation

std::string wns::probe::bus::TextProbeBus::description_ [private]

Definition at line 91 of file TextProbeBus.hpp.

bool wns::probe::bus::TextProbeBus::isJSON_ [private]

Definition at line 81 of file TextProbeBus.hpp.

std::string wns::probe::bus::TextProbeBus::jsonEntrySeparator_ [private]

Definition at line 99 of file TextProbeBus.hpp.

std::string wns::probe::bus::TextProbeBus::key_ [private]

Definition at line 73 of file TextProbeBus.hpp.

std::list<std::string> wns::probe::bus::TextProbeBus::messages_ [private]

Definition at line 93 of file TextProbeBus.hpp.

std::string wns::probe::bus::TextProbeBus::name_ [private]

Definition at line 89 of file TextProbeBus.hpp.

int wns::probe::bus::TextProbeBus::numCalls_ [private]

Definition at line 97 of file TextProbeBus.hpp.

std::string wns::probe::bus::TextProbeBus::outfileBase_ [private]

Definition at line 77 of file TextProbeBus.hpp.

std::string wns::probe::bus::TextProbeBus::outputPath_ [private]

Definition at line 75 of file TextProbeBus.hpp.

bool wns::probe::bus::TextProbeBus::prependSimTimeFlag_ [private]

Definition at line 83 of file TextProbeBus.hpp.

int wns::probe::bus::TextProbeBus::simTimePrecision_ [private]

Definition at line 85 of file TextProbeBus.hpp.

int wns::probe::bus::TextProbeBus::simTimeWidth_ [private]

Definition at line 87 of file TextProbeBus.hpp.

int wns::probe::bus::TextProbeBus::skipInterval_ [private]

Definition at line 95 of file TextProbeBus.hpp.

bool wns::probe::bus::TextProbeBus::writeHeader_ [private]

Definition at line 79 of file TextProbeBus.hpp.

---

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

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