ToolSink Class Reference
[Tool Classes]
This class implements a simple node that stores a copy of the last event it received and passed on for output to the console.
More...
#include <ToolSink.h>
Public Member Functions | |
| virtual int | isEventGenerator () |
| virtual void | onEventGenerated (Event &event, Node &generator) |
Public Attributes | |
| std::string | comment |
| Event | event |
| int | changed |
Protected Member Functions | |
| ToolSink (const std::string &comment_) | |
Friends | |
| class | ToolIOModule |
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
Definition at line 57 of file ToolSink.h.
Constructor & Destructor Documentation
| ToolSink::ToolSink | ( | const std::string & | comment_ | ) | [inline, protected] |
constructor method,sets commend member
- Parameters:
-
comment_ the comment line to use
Definition at line 72 of file ToolSink.h.
Member Function Documentation
| virtual int ToolSink::isEventGenerator | ( | ) | [inline, virtual] |
tests for EventGenerator interface being present.
Is overriden to return 1 always.
- Returns:
- always 1
Definition at line 84 of file ToolSink.h.
| 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.
Definition at line 95 of file ToolSink.h.
References changed.
Friends And Related Function Documentation
friend class ToolIOModule [friend] |
Definition at line 101 of file ToolSink.h.
Member Data Documentation
flag whether event was changed since last display
Definition at line 66 of file ToolSink.h.
Referenced by onEventGenerated().
| std::string ToolSink::comment |
| Event ToolSink::event |
The documentation for this class was generated from the following file: