rovsoft::io::BinarySubstitutionIStreamer Class Reference

This class implements reading from a stream with prefixed specical characters, one such implementation is the robot board protocol. More...

#include <BinarySubstitutionIStreamer.hh>

Inheritance diagram for rovsoft::io::BinarySubstitutionIStreamer:

[legend]Collaboration diagram for rovsoft::io::BinarySubstitutionIStreamer:

[legend]List of all members.

Public Member Functions
	BinarySubstitutionIStreamer (std::istream *in, const char *chars) throw (lib::NullPointerExceptionPtr)
	A SegmentIStreamer must be initialised with a dynamically created istream object.
virtual char	readByte () throw (IOExceptionPtr, PrefixedDataExceptionPtr, UnprefixedMetaDataExceptionPtr)
	returns bytes without prefixes and other special chars

---

Detailed Description

This class implements reading from a stream with prefixed specical characters, one such implementation is the robot board protocol.

Because this class adds new methods it would be better to create an interface called SubstitionIStreamer, but at the moment this isn't neccessary, so I'll leave it.

---

Constructor & Destructor Documentation

rovsoft::io::BinarySubstitutionIStreamer::BinarySubstitutionIStreamer (  std::istream *  in, const char *  chars )  throw (lib::NullPointerExceptionPtr)

A SegmentIStreamer must be initialised with a dynamically created istream object. The deletion of the object is accomplished by this SegmentIStreamer object at destruction. Parameters: chars  A string with characters that will be substituted when writting. The first character in the string specifies the prefix being used for substitution.

---

Member Function Documentation

char rovsoft::io::BinarySubstitutionIStreamer::readByte (   )  throw (IOExceptionPtr, PrefixedDataExceptionPtr, UnprefixedMetaDataExceptionPtr) [virtual]

returns bytes without prefixes and other special chars Exceptions: UnprefixedMetaDataExceptionPtr  If a character contained in the chars array is read and is not prefixed, an UnprefixedMetaDataExceptionPtr is raised. PrefixedDataExceptionPtr  If a character is read that is prefixed and not in the chars array an PrefixedDataExceptionPtr is raised. Reimplemented from rovsoft::io::BinaryIStreamer. Reimplemented in rovsoft::io::BinaryLenSegmentIStreamer. Here is the call graph for this function:

---

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

• BinarySubstitutionIStreamer.hh
• BinarySubstitutionIStreamer.cc

---