User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Seekable Ports - DPISPortAttachC<class DataT>
 

  PUBLIC
DPISPortAttachC::DPISPortAttachC(void)
DPISPortAttachC::DPISPortAttachC(const DPIPortC &,const DPSeekCtrlC &)
DPISPortAttachC::DPISPortAttachC(const DPIPortC &,bool)
DPISPortAttachC::SetSeekCtrl(const DPSeekCtrlC &)
DPISPortC::operator =(const DPISPortC &)
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
DPSeekCtrlC::Seek(UIntT)
DPSeekCtrlC::DSeek(IntT)
DPSeekCtrlC::Tell(void) const
DPSeekCtrlC::Size(void) const
DPSeekCtrlC::Start(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::GetAttr(const StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::Abstract(void)
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(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::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   DPISPortAttachC<class DataT>   
 
Seek control attach.
 
include "Ravl/DP/SPortAttach.hh"
Created:08/04/1999 
User Level:Advanced
Library:RavlIO
In Scope:RavlN

Parent Classes: Methods:
DPISPortAttachC()
Default constructor.
Creates an invalid handle.

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

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

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

#include "Ravl/DP/SPort.hh"
const DPISPortC<DataT> & operator =(const DPISPortC<DataT> & obj)
Assigment.

#include "Ravl/DP/Port.hh"
DataT Get()
Get next piece of data.

bool Get(DataT & buff)
Try and get next piece of data.
If none, return false. else put data into buff.

IntT GetArray(SArray1dC<DataT> & data)
Get an array of data from stream.
returns the number of elements processed.

#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

#include "Ravl/DP/Port.hh"
const type_info & InputType() const
Get type of input port.

bool IsGetReady() const
Is valid data.

bool IsGetEOS() const
Is valid data.

bool Discard()
Discard the next input datum.
returns true on success.

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

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

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

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.

StringC GetAttr(const StringC & attrName)
Get a stream attribute.
Return the value of an attribute or an empty string if its unkown. 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'.

RCAbstractC Abstract()
Create an abstract handle.

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

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

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

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#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: 08/04/1999, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002