PUBLIC

StreamBaseC::StreamBaseC(void) StreamBaseC::StreamBaseC(const StreamBaseC &) StreamBaseC::~StreamBaseC(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::StreamBaseC(ios *,StringC,BooleanT) 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

StreamBaseC
include	"amma/Stream.hh"
User Level:	Default
Library:	MstdIO
Example:	exComplx.cc
Section:	Basic Types.IO
In Scope:	std

Parent Classes:

public RefCounterC

OStreamC
IStreamC

typedef ios::seek_dir SeekDirT;

GCC...

StringC name;

Name of stream.

ios * s;

BooleanT delOnClose;

StreamBaseC()

Default constructor.

StreamBaseC(const StreamBaseC & oth)

Copy Constructor.

~StreamBaseC()

Ensure correct destructor is used.

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!

StreamBaseC(ios * ns,StringC afilename,BooleanT nDelOnClose)

Body Constructor.

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.