PUBLIC

OSerialC::OSerialC(void) OSerialC::OSerialC(const char *,BooleanT) OStreamC::form(const char *,...) OStreamC::operator ostream &(void) OStreamC::operator const ostream &(void) const OStreamC::os(void) OStreamC::os(void) const OStreamC::operator=(const OStreamC &) OStreamC::write(const char *,streamsize) OStreamC::put(char) OStreamC::operator<<(const char *) OStreamC::operator<<(const DataT &) OStreamC::Tell(void) const OStreamC::Seek(streampos) OStreamC::tellp(void) const OStreamC::seekg(streampos) OStreamC::seekg(streampos,SeekDirT) SerialCtrlC::Setup(IntT,IntT,IntT,ParityT,IntT) SerialCtrlC::SetISpeed(const IntT) SerialCtrlC::SetOSpeed(const IntT) SerialCtrlC::SetStopBits(const IntT) SerialCtrlC::SetCharSize(const IntT) SerialCtrlC::SetParity(ParityT) SerialCtrlC::Getfd(void) SerialCtrlC::SerialInit(IntT,IntT,IntT,IntT,ParityT,IntT) SerialCtrlC::SpeedSetting(int) SerialCtrlC::SetISpeed(termios &,IntT) SerialCtrlC::SetOSpeed(termios &,IntT) SerialCtrlC::SetCharSize(termios &,IntT) SerialCtrlC::SetStopBits(termios &,IntT) SerialCtrlC::SetParity(termios &,ParityT) StreamBaseC::Name(void) const StreamBaseC::IsOpen(void) const StreamBaseC::good(void) const StreamBaseC::bad(void) const StreamBaseC::eof(void) const StreamBaseC::fail(void) const StreamBaseC::operator!(void) const StreamBaseC::operator void *(void) const StreamBaseC::DiagnoseStream(ostream &) StreamBaseC::Close(void) StreamBaseC::Init(ios *,StringC,BooleanT) StreamBaseC::operator=(const StreamBaseC &) StreamBaseC::buf(void) StreamBaseC::buf(void) const RefCounterC::ToBeDeleted(void) const RefCounterC::Count(void) const RefCounterC::IsSingleReference(void) RefCounterC::operator=(const RefCounterC &) RefCounterC::ToBeDeletedUpdate(const RefCounterC &) RefCounterC::ReportInvalidObject(char *) RefCounterBaseC::Label(void) const

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

Parent Classes:

public OStreamC
public SerialCtrlC

OSerialC()

Default constructor.
Creates an invalid handle.

OSerialC(const char * dev,BooleanT buffered = false)

Open a output serial stream.

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.

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;

BooleanT SerialInit(IntT fd,IntT i_speed = 9600,IntT o_speed = 9600,IntT stop_bit = 1,ParityT par = PARITY_NONE,IntT char_size = 8)

Initialize 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)

int SpeedSetting(int bitrate)

Get setting to use for a bit rate.
returns -1 for illegal values.

BooleanT SetISpeed(termios & pb,IntT bitrate)

Set input bit rate.

BooleanT SetOSpeed(termios & pb,IntT bitrate)

Set ouput bit rate.

BooleanT SetCharSize(termios & pb,IntT bits)

Set bit rate.

BooleanT SetStopBits(termios & pb,IntT bits)

Set bit rate.

BooleanT SetParity(termios & pb,ParityT par)

parity type: Odd or Even or None or 1

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!

BooleanT Init(ios * ns,StringC afilename,BooleanT nDelOnClose = true)

Setup
This should only be called on Stream's constructed with the default constructor!

const StreamBaseC & operator=(const StreamBaseC & oth)

Assigment.

ios & buf()

Access handle.

const ios & buf() const

Access handle.

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.

const RefCounterC & operator=(const RefCounterC & rC)

BooleanT ToBeDeletedUpdate(const RefCounterC & rC)

This function is the condition and the assigment together. It returns TRUE if the content should be deleted before assigning of the new object. The function automatically solves the reference counter of this object as well as the other object reference counter 'rC'.

void ReportInvalidObject(char * Msg = 0)

This function reports an error to the user if a problem is detected in the refrence counting mechanism.

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.