SimTK::TextDataEventReporter Class Reference

This is an EventReporter which prints out numeric data at regular intervals in tabular form. More...

#include <TextDataEventReporter.h>

Inheritance diagram for SimTK::TextDataEventReporter:

List of all members.

Public Member Functions
	TextDataEventReporter (const System &system, UserFunction< Real > *function, Real reportInterval)
	Create a TextDataEventReporter which calculates a single number at each reporting interval, and displays it along with the time.
	TextDataEventReporter (const System &system, UserFunction< Vector > *function, Real reportInterval)
	Create a TextDataEventReporter which calculates a vector of numbers at each reporting interval, and displays them along with the time.
	~TextDataEventReporter ()
void	handleEvent (const State &state) const
	This method is invoked to handle the event.
Protected Member Functions
const TextDataEventReporterRep &	getRep () const
TextDataEventReporterRep &	updRep () const
Protected Attributes
TextDataEventReporterRep *	rep

---

Detailed Description

This is an EventReporter which prints out numeric data at regular intervals in tabular form.

You provide it with a UserFunction, which calculates the values to be reported. At every reporting interval, it invokes the UserFunction, then prints out the current time along with the value or values returned by the function.

After creating a TextDataEventReporter, add it to the System by calling the addEventReporter() method.

---

Constructor & Destructor Documentation

SimTK::TextDataEventReporter::TextDataEventReporter	(	const System &	system,
		UserFunction< Real > *	function,
		Real	reportInterval
	)

Create a TextDataEventReporter which calculates a single number at each reporting interval, and displays it along with the time.

SimTK::TextDataEventReporter::TextDataEventReporter	(	const System &	system,
		UserFunction< Vector > *	function,
		Real	reportInterval
	)

Create a TextDataEventReporter which calculates a vector of numbers at each reporting interval, and displays them along with the time.

SimTK::TextDataEventReporter::~TextDataEventReporter

(

)

---

Member Function Documentation

void SimTK::TextDataEventReporter::handleEvent

(

const State &

state

)

const [virtual]

This method is invoked to handle the event.

It is given a State which describes the system at the time when the event occurs.

Implements SimTK::EventReporter.

const TextDataEventReporterRep& SimTK::TextDataEventReporter::getRep

(

)

const [inline, protected]

TextDataEventReporterRep& SimTK::TextDataEventReporter::updRep

(

)

const [inline, protected]

---

Member Data Documentation

TextDataEventReporterRep* SimTK::TextDataEventReporter::rep [protected]

---

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

• TextDataEventReporter.h