Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Seekable Ports - DPISPortAttachBodyC<class DataT>
 

  PUBLIC
DPISPortAttachBodyC::DPISPortAttachBodyC(void)
DPISPortAttachBodyC::DPISPortAttachBodyC(const DPIPortC &,const DPSeekCtrlC &)
DPISPortAttachBodyC::DPISPortAttachBodyC(const DPIPortC &,bool)
DPISPortAttachBodyC::Seek(UIntT)
DPISPortAttachBodyC::DSeek(IntT)
DPISPortAttachBodyC::Tell(void) const
DPISPortAttachBodyC::Size(void) const
DPISPortAttachBodyC::Start(void) const
DPISPortAttachBodyC::IsGetReady(void) const
DPISPortAttachBodyC::IsGetEOS(void) const
DPISPortAttachBodyC::InputType(void) const
DPISPortAttachBodyC::Get(void)
DPISPortAttachBodyC::Get(DataT &)
DPISPortAttachBodyC::ConnectedTo(void) const
DPSeekCtrlAttachBodyC::Seek(UIntT)
DPSeekCtrlAttachBodyC::DSeek(IntT)
DPSeekCtrlAttachBodyC::Tell(void) const
DPSeekCtrlAttachBodyC::Size(void) const
DPSeekCtrlAttachBodyC::Start(void) const
DPSeekCtrlAttachBodyC::SetSeekCtrl(const DPSeekCtrlC &)
DPIPortBodyC::Get(void)
DPIPortBodyC::Get(DataT &)
DPIPortBodyC::GetArray(SArray1dC &)
DPIPortBodyC::InputType(void) const
DPIPortBodyC::Save(ostream &) const
DPIPortBodyC::Discard(void)
DPSeekCtrlBodyC::Seek(UIntT)
DPSeekCtrlBodyC::DSeek(IntT)
DPSeekCtrlBodyC::Tell(void) const
DPSeekCtrlBodyC::Size(void) const
DPSeekCtrlBodyC::Start(void) const
DPSeekCtrlBodyC::Seek(UIntT)
DPSeekCtrlBodyC::DSeek(IntT)
DPSeekCtrlBodyC::Tell(void) const
DPSeekCtrlBodyC::Size(void) const
DPSeekCtrlBodyC::Start(void) const
DPIPortBaseBodyC::IsGetReady(void) const
DPIPortBaseBodyC::IsGetEOS(void) const
DPIPortBaseBodyC::InputType(void) const
DPIPortBaseBodyC::Save(ostream &) const
DPIPortBaseBodyC::Discard(void)
DPEntityBodyC::Save(ostream &) const
DPEntityBodyC::Save(BinOStreamC &) const
DPEntityBodyC::Copy(void) const
DPPortBodyC::IsAsync(void) const
DPPortBodyC::Save(ostream &) const
DPPortBodyC::ConnectedTo(void) const
DPPortBodyC::GetAttr(const StringC &,StringC &)
DPPortBodyC::SetAttr(const StringC &,const StringC &)
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
DPEntityBodyC::Save(ostream &) const
DPEntityBodyC::Save(BinOStreamC &) const
DPEntityBodyC::Copy(void) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   DPISPortAttachBodyC<class DataT>   
 
Seek control attach.
 
include "Ravl/DP/SPortAttach.hh"
Created:08/04/1999 
Source file:Ravl/Core/IO/SPortAttach.hh
User Level:Develop
Library:RavlIO
In Scope:RavlN

Parent Classes: Variables:
DPIPortC port;

Methods:
DPISPortAttachBodyC()
Default constructor.

DPISPortAttachBodyC(const DPIPortC<DataT> & aport,const DPSeekCtrlC & sc)
Constructor.
Attach 'aport' to seek ctrl 'sc'

DPISPortAttachBodyC(const DPIPortC<DataT> & aport,bool smartDefault = true)
Constructor.
Attach 'aport' to seek ctrl 'sc'

bool Seek(UIntT off)
Seek to location in stream.

bool DSeek(IntT off)
Delta Seek, goto location relative to the current one.

UIntT Tell() const
Find current location in stream.

UIntT Size() const
Find the total size of the stream.

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

bool IsGetReady() const
Is some data ready ?
true = yes. Defaults to !IsGetEOS().

bool IsGetEOS() const
Has the End Of Stream been reached ?
true = yes.

const type_info & InputType() const
Input type.

DataT Get()
Get next piece of data.

bool Get(DataT & buff)
Try and get next piece of data.

DPPortC ConnectedTo() const
What does this connect to ?

bool Seek(UIntT off)
Seek to location in stream.

bool DSeek(IntT off)
Delta Seek, goto location relative to the current one.

UIntT Tell() const
Find current location in stream.

UIntT Size() const
Find the total size of the stream.

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

void SetSeekCtrl(const DPSeekCtrlC & sc)
Set seek control.

#include "Ravl/DP/Port.hh"
DataT Get()
Get next piece of data.
May block if not ready, or it could throw an DataNotReadyC exception. NB. This function MUST be provided by client class.

bool Get(DataT & buff)
Try and get next piece of data.
This may not NOT block, if no data is ready it will return false, and not set buff. NB. The default version of this function uses the Get() method defined above and so need not be provided by derived classes.

IntT GetArray(SArray1dC<DataT> & data)
Get an array of data from stream.
returns the number of elements succesfully processed. NB. This need NOT be overridden in client classes unless fast handling of arrays of data elements is required.

const type_info & InputType() const
Input type.

bool Save(ostream & out) const
Save to ostream.

bool Discard()
Discard the next input datum.

#include "Ravl/DP/SPort.hh"
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

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/Port.hh"
bool IsGetReady() const
Is some data ready ?
true = yes. Defaults to !IsGetEOS().

bool IsGetEOS() const
Has the End Of Stream been reached ?
true = yes.

const type_info & InputType() const
Input type.

bool Save(ostream & out) const
Save to ostream.

bool Discard()
Discard the next input datum.

#include "Ravl/DP/Entity.hh"
bool Save(ostream & out) const
Save to ostream.

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

RCBodyVC & Copy() const
Creat a copy of this object.

#include "Ravl/DP/Port.hh"
bool IsAsync() const
Does port work asynchronously ?

bool Save(ostream & out) const
Save to ostream.

DPPortC ConnectedTo() const
Is this port connected to another ?
If not returns invalid handle.

bool GetAttr(const StringC & attrName,StringC & attrValue)
Get a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

bool SetAttr(const StringC & attrName,const StringC & attrValue)
Set a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

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

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

RCBodyVC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/DP/Entity.hh"
bool Save(ostream & out) const
Save to ostream.

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

RCBodyVC & Copy() const
Creat a copy of this object.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


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