User Documentation
RAVL, Recognition And Vision Library
Ravl - Core - Data Processing - Seekable Ports - DPSeekCtrlC

DPSeekCtrlC::DPSeekCtrlC(bool,const DPPortC &)
DPSeekCtrlC::DPSeekCtrlC(const DPSeekCtrlC &)
DPSeekCtrlC::DPSeekCtrlC(const DPEntityC &)
DPSeekCtrlC::Tell(void) const
DPSeekCtrlC::Size(void) const
DPSeekCtrlC::Start(void) const
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void) const
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
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::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

Stream position control handle class.
include "Ravl/DP/SPort.hh"
User Level:Normal
In Scope:RavlN

This class provides an abstract base class which allows the streams position to be queried and manipulated.

Parent Classes: Derived Classes: Methods:
Default constructor.

DPSeekCtrlC(bool stubIt,const DPPortC & pb = DPPortC ())
If stubIt is true, a body the produces no error message is used, otherwise its a noisy one.

DPSeekCtrlC(const DPSeekCtrlC & oth)
Copy constructor.

DPSeekCtrlC(const DPEntityC & oth)
Base Constructor.

bool Seek(UIntT off)
Seek to location in stream.
Returns false, if seek failed. (Maybe because its not implemented.) if an error occurered (Seek returned False) then stream position will not be changed.

bool DSeek(IntT off)
Delta Seek, goto location relative to the current one.
The default behavour of this functions is : Do some error checking then: Seek((UIntT)((IntT) Tell() + off)); if an error occurered (DSeek returned False) then stream position will not be changed.

UIntT Tell() const
Find current location in stream.
Defined as the index of the next object to be written or read. May return ((UIntT) (-1)) if not implemented.

UIntT Size() const
Find the total size of the stream. (assuming it starts from 0)
May return ((UIntT) (-1)) if not implemented.

UIntT Start() const
Find the offset where the stream begins, normally zero.
Defaults to 0

#include "Ravl/DP/Entity.hh"
const DPEntityC & operator =(const DPEntityC & dat)

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/RCHandleV.hh"
bool Save(ostream & out) const
Save to stream 'out'.

bool Save(BinOStreamC & out) const
Save to binary stream 'out'.

RCAbstractC Abstract()
Create an abstract handle.

istream & operator >>(istream & strm,RCHandleVC<DPEntityBodyC> & obj)

BinIStreamC & operator >>(BinIStreamC & strm,RCHandleVC<DPEntityBodyC> & obj)

#include "Ravl/RefCounter.hh"
const RCHandleC<DPEntityBodyC> & operator =(const RCHandleC<DPEntityBodyC> & oth)
Assign handle.

RCHandleC<DPEntityBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<DPEntityBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<DPEntityBodyC> & 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.

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

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

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

Maintainer:Charles Galambos, Created: 27/10/1998, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002