InstantIO::BasicDecoder Class Reference
Abstract base class of all Decoder templates. More...
#include <InstantIO/BasicDecoder.h>
Inheritance diagram for InstantIO::BasicDecoder:
Public Member Functions | |
| virtual | ~BasicDecoder () |
| Destroys the BasicDecoder object. | |
| virtual void | initialize (const std::string &label, const std::string &description) |
| Initializes the Decoder object. | |
| const std::string | getLabel () const |
| Returns the label of the OutSlot we write the decoded values to. | |
| virtual BasicOutSlot * | getOutSlot () const =0 |
| Returns the OutSlot we write the decoded values to. | |
| virtual void | decodeAndPush (const SetStateEvent &event) |
| Gets the binary representation of an object from the event, decodes the object, and writes it to the OutSlot. | |
Protected Member Functions | |
| BasicDecoder () | |
| Creates a new BasicDecoder object. | |
| virtual void | decodeAndPush (std::istream &is, TimeStamp timeStamp)=0 |
| Gets the binary representation of an object from a stream, decodes the object, and writes it to the OutSlot. | |
Detailed Description
Abstract base class of all Decoder templates.
Member Function Documentation
| virtual void InstantIO::BasicDecoder::initialize | ( | const std::string & | label, | |
| const std::string & | description | |||
| ) | [virtual] |
Initializes the Decoder object.
Reimplemented in InstantIO::Decoder< T >.
| const std::string InstantIO::BasicDecoder::getLabel | ( | ) | const [inline] |
| virtual BasicOutSlot* InstantIO::BasicDecoder::getOutSlot | ( | ) | const [pure virtual] |
Returns the OutSlot we write the decoded values to.
- Returns:
- The OutSlot
Implemented in InstantIO::Decoder< T >.
| virtual void InstantIO::BasicDecoder::decodeAndPush | ( | const SetStateEvent & | event | ) | [virtual] |
Gets the binary representation of an object from the event, decodes the object, and writes it to the OutSlot.
- Parameters:
-
event The event we get the binary representation from.
| virtual void InstantIO::BasicDecoder::decodeAndPush | ( | std::istream & | is, | |
| TimeStamp | timeStamp | |||
| ) | [protected, pure virtual] |
Gets the binary representation of an object from a stream, decodes the object, and writes it to the OutSlot.
- Parameters:
-
is The stream we get the binary representation from. timeStamp The timestamp of the data value.
Implemented in InstantIO::Decoder< T >.
The documentation for this class was generated from the following file:
