PUBLIC

OSerialC::OSerialC(void) OSerialC::OSerialC(const char *,bool) OStreamC::form(const char *,...) OStreamC::os(void) OStreamC::os(void) const OStreamC::operator ostream &(void) OStreamC::operator const ostream &(void) const OStreamC::write(const char *,StreamSizeT) OStreamC::put(char) OStreamC::operator <<(const char *) OStreamC::operator <<(const DataT &) OStreamC::Tell(void) const OStreamC::Seek(streampos) OStreamC::tellp(void) const OStreamC::seekp(streampos) OStreamC::seekp(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(istream *,StringC,bool) StreamBaseC::Init(ostream *,StringC,bool) StreamBaseC::buf(void) StreamBaseC::buf(void) const HandleRefCounterC::SetDestructionOp(const TriggerC &) HandleRefCounterC::References(void) const RCHandleC::operator =(const RCHandleC &) RCHandleC::DeepCopy(UIntT) const RCHandleC::operator ==(const RCHandleC &) const RCHandleC::operator !=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsValid(void) const RCHandleC::Invalidate(void) RCHandleC::IsHandleType(const DT &) const RCHandleC::CheckHandleType(const DT &) const RCHandleC::Body(void) RCHandleC::Body(void) const RCHandleC::References(void) const RCHandleC::operator <<(ostream &,const RCHandleC &) RCHandleC::operator >>(istream &,RCHandleC &)

public OStreamC
public SerialCtrlC

OSerialC()

Default constructor.
Creates an invalid handle.

OSerialC(const char * dev,bool 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.

ostream & os()

Access ostream.

const ostream & os() const

Access ostream.

operator ostream &()

Converter.

operator const ostream &() const

Converter.

ostream & write(const char * d,StreamSizeT n)

Write data.
ostream compatable.

ostream & put(char ch)

Put character.
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 & seekp(streampos to)

Goto a position in the stream.
ostream compatable.

ostream & seekp(streampos to,SeekDirT dir)

Goto a position in the stream.
ostream compatable.

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

bool SetISpeed(const IntT i_speed)

set the input speed of the port;

bool SetOSpeed(const IntT o_speed)

set the output speed of the port;

bool SetStopBits(const IntT stop_bit)

set the number of stop bits : 1 or 2;

bool SetCharSize(const IntT char_size)

set the character size: 5,6,7,8;

bool SetParity(ParityT par)

parity type: Odd or Even or None or 1

IntT Getfd()

Get the file discriptor of the port;

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

static int SpeedSetting(int bitrate)

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

bool SetISpeed(termios & pb,IntT bitrate)

Set input bit rate.

bool SetOSpeed(termios & pb,IntT bitrate)

Set ouput bit rate.

bool SetCharSize(termios & pb,IntT bits)

Set bit rate.

bool SetStopBits(termios & pb,IntT bits)

Set bit rate.

bool SetParity(termios & pb,ParityT par)

parity type: Odd or Even or None or 1

const StringC & Name() const

Returns the name of the stream.

bool IsOpen() const

Test if this stream is open.

bool good() const

Is stream good ?

bool bad() const

Is stream corrupted ?

bool eof() const

End of file ?

bool fail() const

Operation failed ?

bool operator !() const

Not failed ?

operator void *() const

Ok ?

bool 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!

bool Init(istream * ns,StringC afilename,bool nDelOnClose = true)

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

bool Init(ostream * ns,StringC afilename,bool nDelOnClose = true)

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

ios & buf()

Access handle.

const ios & buf() const

Access handle.

void SetDestructionOp(const TriggerC & ntrig)

Set trigger to call on delete.

UIntT References() const

Returns the number of references to this object.

const RCHandleC<HandleRefCounterBodyC> & operator =(const RCHandleC<HandleRefCounterBodyC> & oth)

Assign handle.

RCHandleC<HandleRefCounterBodyC> DeepCopy(UIntT levels = ((UIntT))) const

Do a deep copy of the object.

bool operator ==(const RCHandleC<HandleRefCounterBodyC> & oth) const

Are handles to the same object ?

bool operator !=(const RCHandleC<HandleRefCounterBodyC> & oth) const

Are handles to different objects ?

UIntT Hash() const

Default hash function.
This hashes on the address of the body.

bool IsValid() const

Test if this is a valid handle.

void Invalidate()

Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

HandleRefCounterBodyC & Body()

Access body of object.

const HandleRefCounterBodyC & Body() const

Constant access to body of object.

UIntT References() const

Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<HandleRefCounterBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<HandleRefCounterBodyC> & obj)