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

  PUBLIC
DPIPortC::DPIPortC(void)
DPIPortC::DPIPortC(const DPIPortC &)
DPIPortC::DPIPortC(DPIPortBodyC &)
DPIPortC::DPIPortC(const DPIPortBaseC &)
DPIPortC::DPIPortC(istream &)
DPIPortC::Body(void)
DPIPortC::Body(void) const
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
DPIPortBaseC::Body(void)
DPIPortBaseC::Body(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
DPPortC::Body(void)
DPPortC::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 &)
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
RCHandleVC::Body(void) const
RCHandleVC::Body(void)
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::Abstract(void)
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::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 &)

   DPIPortC<class DataT>   
 
Input port.
 
include "Ravl/DP/Port.hh"
Created:16/06/1998 
Source file:Ravl/Core/IO/Port.hh
User Level:Normal
Library:RavlIO
In Scope:RavlN

Parent Classes: Derived Classes: Methods:
DPIPortC()
Default constructor.

DPIPortC(const DPIPortC<DataT> & oth)
Copy constructor.

DPIPortC(DPIPortBodyC<DataT> & bod)
Body constructor.

DPIPortC(const DPIPortBaseC & oth)
Base constructor.

DPIPortC(istream & in)
Stream constructor.

DPIPortBodyC<DataT> & Body()
Access body.

const DPIPortBodyC<DataT> & Body() const
Access body.

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.

DPIPortBaseBodyC & Body()
Access body.

const DPIPortBaseBodyC & Body() const
Access body.

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.

DPPortBodyC & Body()
Access body.

const DPPortBodyC & Body() const
Access body.

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/DP/Entity.hh"
const DPEntityC & operator =(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/RCHandleV.hh"
const DPEntityBodyC & Body() const
Constant access to body of object.

DPEntityBodyC & Body()
Constant access to body of object.

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.

DPEntityBodyC & Body()
Access body of object.

const DPEntityBodyC & 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<DPEntityBodyC> & obj)

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


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