IOSerialC - Input/Output serial stream.

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

IStreamC

OStreamC

SerialCtrlC

Methods:

IOSerialC(): Default constructor.
Creates an invalid handle.
IOSerialC(const char * dev,BooleanT buffered = false): Open an input serial stream.

#include "amma/Stream.hh"

void Unget(StringC text): Put string pack. (Puts a '\n')
void Unget(const char * dat,int len): Put string pack.
IntT CopyTo(OStreamC & out,IntT maxChars = -1): Copy stream to output.
operator istream &(): Converter.
operator const istream &() const: Converter.
istream & is(): Access input stream.
const istream & is() const
const IStreamC & operator=(const IStreamC & oth): Assigment.
istream & read(char * d,streamsize n): read data.
istream compatable function.
istream & get(char & ch): Get charactor.
istream compatable function.
char get(): Get charactor.
istream compatable function.
istream & get(char * buff,int buffsize): Read in a line.
istream compatable function.
istream & getline(char * buff,int buffsize): Read in a line.
istream compatable function.
streamsize gcount(): Get number of charactor read in last operation.
istream compatable function.
istream & operator>>(DataT & dat)
istream & operator>>(char * dat)
streampos Tell() const: Where are we in the stream.
void Seek(streampos to): Goto a position in the stream.
streampos tellg() const: Where are we in the stream.
istream compatable function.
istream & seekg(streampos to): Goto a position in the stream.
istream compatable function.
istream & seekg(streampos to,SeekDirT dir): Goto a position in the stream.
istream compatable.
BooleanT IsEndOfStream(): Test if its the end of the stream is comming up...
Maybe there's a better way ?
ostream & form(const char * format,...): Print to stream using good old 'C' sytle formating.
This isn't the saftest function, it uses a fixed buffer of 4096 bytes.
This is a duplication of the function GNU iostreams for those platforms that don't have this function.
operator ostream &(): Converter.
operator const ostream &() const: Converter.
ostream & os(): Access ostream.
const ostream & os() const
const OStreamC & operator=(const OStreamC & oth): Assigment.
ostream & write(const char * d,streamsize n): Write data.
ostream compatable.
ostream & put(char ch): Put charactor.
ostream compatable.
ostream & operator<<(const char * txt): Output text.
ostream & operator<<(const DataT & dat)
streampos Tell() const: Where are we in the stream.
void Seek(streampos to): Goto a position in the stream.
streampos tellp() const: Where are we in the stream.
ostream compatable.
ostream & seekg(streampos to): Goto a position in the stream.
ostream compatable.
ostream & seekg(streampos to,SeekDirT dir): Goto a position in the stream.
ostream compatable.

#include "amma/SerialIO.hh"

BooleanT Setup(IntT i_speed = 9600,IntT o_speed = 9600,IntT stop_bit = 1,ParityT par = PARITY_NONE,IntT char_size = 8): Setup the port.
with the given parameters: Input speed, Output speed, stop bit(1,2), parity(exist or not exist), parity type(odd or even) and charactoe size(5,6,7,8)
BooleanT SetISpeed(const IntT i_speed): set the input speed of the port;
BooleanT SetOSpeed(const IntT o_speed): set the output speed of the port;
BooleanT SetStopBits(const IntT stop_bit): set the number of stop bits : 1 or 2;
BooleanT SetCharSize(const IntT char_size): set the charactor size: 5,6,7,8;
BooleanT SetParity(ParityT par): parity type: Odd or Even or None or 1
IntT Getfd(): Get the file discriptor of the port;

#include "amma/Stream.hh"

const StringC & Name() const: Returns the name of the stream.
BooleanT IsOpen() const: Test if this stream is open.
BooleanT good() const: Is stream good ?
BooleanT bad() const: Is stream corrupted ?
BooleanT eof() const: End of file ?
BooleanT fail() const: Operation failed ?
BooleanT operator!() const: Not failed ?
operator void *() const: Ok ?
BooleanT DiagnoseStream(ostream & out): Print diagnostic message about the streams state to out.
bool Close(): Close this stream.
After this is called no further IO should be attempted!
const StringC & Name() const: Returns the name of the stream.
BooleanT IsOpen() const: Test if this stream is open.
BooleanT good() const: Is stream good ?
BooleanT bad() const: Is stream corrupted ?
BooleanT eof() const: End of file ?
BooleanT fail() const: Operation failed ?
BooleanT operator!() const: Not failed ?
operator void *() const: Ok ?
BooleanT DiagnoseStream(ostream & out): Print diagnostic message about the streams state to out.
bool Close(): Close this stream.
After this is called no further IO should be attempted!

#include "amma/RefCount.hh"

BooleanT ToBeDeleted() const: Returns TRUE if the content should be deleted.
RCCountT Count() const: Returns the number of refrences to this object. NB. The following definition is now obsolete, The value 0 means there is no other reference to this object.
BooleanT IsSingleReference(): Tests is there is only one reference to this object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Fangxiang Cheng, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

IOSerialC

Input/Output serial stream.

include	"amma/SerialIO.hh"
User Level:	Default
Library:	Msys
Example:	exChild.cc
Section:	Basic_Types.IO.IOSerial
In Scope:	std