ToolSink Class Reference
[Tool Classes]

#include <ToolSink.h>

List of all members.

---

Detailed Description

This class implements a simple node that stores a copy of the last event it received and passed on for output to the console. The associated ConsoleModule polls the nodes regularly and prints out the last event stored.

Author:

Gerhard Reitmayr

Public Member Functions
virtual int	isEventGenerator ()
virtual void	onEventGenerated (Event &event, Node &generator)
Public Attributes
std::string	comment
	comment line
Event	event
	the event that is stored
int	changed
	flag whether event was changed since last display
Protected Member Functions
	ToolSink (const std::string &comment_)
Friends
class	ToolIOModule

---

Constructor & Destructor Documentation

ToolSink::ToolSink (  const std::string &  comment_  )  [inline, protected]

constructor method,sets commend member Parameters: comment_  the comment line to use

---

Member Function Documentation

virtual int ToolSink::isEventGenerator (   )  [inline, virtual]

tests for EventGenerator interface being present. Is overriden to return 1 always. Returns: always 1

virtual void ToolSink::onEventGenerated (  Event &  event, Node &  generator )  [inline, virtual]

this method notifies the object that a new event was generated. Parameters: event  reference to the new event. generator  reference to the EventGenerator object that notified the EventObserver.

---

Friends And Related Function Documentation

friend class ToolIOModule [friend]

---

Member Data Documentation

int ToolSink::changed

flag whether event was changed since last display

std::string ToolSink::comment

comment line

Event ToolSink::event

the event that is stored

---

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

• include/OpenTracker/tool/ToolSink.h

---