InstantIO::BasicEncoder Class Reference

Abstract base class of all Encoder templates. More...

Inheritance diagram for InstantIO::BasicEncoder:

Public Member Functions
virtual	~BasicEncoder ()
	Destroys the BasicEncoder object.
virtual void	initialize (const std::string &label, const std::string &description)
	Initializes the encoder object.
const std::string &	getLabel () const
	Returns the label of the InSlot we read the values we have to encode from.
virtual BasicInSlot *	getInSlot () const =0
	Returns the InSlot we read the values that have to be encoded from.
virtual void	popAndEncode (SetStateEvent &event)
	Reads a value from the InSlot, encodes it, and puts the result into an event.
Protected Member Functions
	BasicEncoder ()
	Creates a new BasicEncoder object.
virtual TimeStamp	popAndEncode (std::ostream &os)=0
	Reads a value from the InSlot and encodes it into an output stream.

Detailed Description

Abstract base class of all Encoder templates.

virtual void InstantIO::BasicEncoder::initialize	(	const std::string &	label,
		const std::string &	description
	)			`[virtual]`

Initializes the encoder object.

Parameters:

	label	The label of the InSlot
	description	The description of the InSlot

const std::string& InstantIO::BasicEncoder::getLabel ( ) const [inline]

Returns the label of the InSlot we read the values we have to encode from.

virtual BasicInSlot* InstantIO::BasicEncoder::getInSlot ( ) const [pure virtual]

Returns the InSlot we read the values that have to be encoded from.

virtual void InstantIO::BasicEncoder::popAndEncode ( SetStateEvent & event ) [virtual]

Reads a value from the InSlot, encodes it, and puts the result into an event.

Parameters:

event

The event we put the result into.

virtual TimeStamp InstantIO::BasicEncoder::popAndEncode ( std::ostream & os ) [protected, pure virtual]

Reads a value from the InSlot and encodes it into an output stream.

Parameters:

os

The stream we put the result into.

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