Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - IO - Streams - StreamBaseC
 

  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(ostream *,StringC,bool)
StreamBaseC::StreamBaseC(istream *,StringC,bool)
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 &)

   StreamBaseC   
 
Reference counter IO stream base class.
 
include "Ravl/Stream.hh"
Created:23/04/1998 
Source file:Ravl/Core/Base/Stream.hh
User Level:Develop
Library:RavlCore
In Scope:RavlN

Parent Classes: Derived Classes: Typedefs:
typedef std::ios::seekdir SeekDirT;
GCC...

Variables:
StringC name;
Name of stream.

ios * s;

Methods:
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.

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!

StreamBaseC(ostream * ns,StringC afilename,bool nDelOnClose = true)
Body Constructor.

StreamBaseC(istream * ns,StringC afilename,bool nDelOnClose = true)
Body Constructor.

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.

#include "Ravl/HandleRefCounter.hh"
void SetDestructionOp(const TriggerC & ntrig)
Set trigger to call on delete.

UIntT References() const
Returns the number of references to this object.

#include "Ravl/RefCounter.hh"
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)


Maintainer:Charles Galambos, Created: 23/04/1998, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002