Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
IStreamC::IStreamC(void)
IStreamC::IStreamC(const StringC &,BooleanT,BooleanT)
IStreamC::IStreamC(int,BooleanT)
IStreamC::IStreamC(istream &,BooleanT)
IStreamC::IStreamC(const IStreamC &)
IStreamC::Unget(StringC)
IStreamC::Unget(const char *,int)
IStreamC::CopyTo(OStreamC &,IntT)
IStreamC::operator istream &(void)
IStreamC::operator const istream &(void) const
IStreamC::is(void)
IStreamC::is(void) const
IStreamC::~IStreamC(void)
IStreamC::operator=(const IStreamC &)
IStreamC::read(char *,streamsize)
IStreamC::get(char &)
IStreamC::get(void)
IStreamC::get(char *,int)
IStreamC::getline(char *,int)
IStreamC::gcount(void)
IStreamC::operator>>(DataT &)
IStreamC::operator>>(char *)
IStreamC::Tell(void) const
IStreamC::Seek(streampos)
IStreamC::tellg(void) const
IStreamC::seekg(streampos)
IStreamC::seekg(streampos,SeekDirT)
IStreamC::IsEndOfStream(void)
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
IStreamC
 
Standard input streams with refrence counting.
 
include "amma/Stream.hh"
User Level:Default
Library:MstdIO
Example:exComplx.cc
Section:Basic Types.IO
In Scope:std

Parent Classes:

Derived Classes: Variables:
istream * in;

Methods:
IStreamC()
Default constructor.

IStreamC(const StringC & filename,BooleanT binary = false,BooleanT buffered = true)
Open a file.
'-' is treated as cin.

IStreamC(int fd,BooleanT buffered = true)
Get data from unix filehandle.

IStreamC(istream & strm,BooleanT deletable = false)
Constructor.

IStreamC(const IStreamC & oth)
Copy constructor.

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

~IStreamC()
Destructor.

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 ?

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.

#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.

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.

#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:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001