User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Internal - DPProcIStreamBodyC<class InT,class OutT>
 

  PUBLIC
DPProcIStreamBodyC::DPProcIStreamBodyC(const DPProcessC &,const DPIPortC &)
DPProcIStreamBodyC::DPProcIStreamBodyC(const DPProcessC &)
DPProcIStreamBodyC::DPProcIStreamBodyC(const DPProcIStreamBodyC &)
DPProcIStreamBodyC::Get(void)
DPProcIStreamBodyC::Get(OutT &)
DPProcIStreamBodyC::GetArray(SArray1dC &)
DPProcIStreamBodyC::Copy(void) const
DPProcessC::Apply(const InT &)
DPProcessC::ApplyArray(const SArray1dC &,SArray1dC &)
DPProcessC::operator =(const DPProcessC &)
DPProcessC::Copy(void) const
DPIStreamOpBodyC::IsGetReady(void) const
DPIStreamOpBodyC::IsGetEOS(void) const
DPIStreamOpBodyC::ConnectedTo(void) const
DPIStreamOpBodyC::IPorts(void) const
DPIStreamOpBodyC::IPlugs(void) const
DPIStreamOpBodyC::Input(void)
DPProcessBaseC::NoInputs(void) const
DPProcessBaseC::NoOutputs(void) const
DPProcessBaseC::InputType(int) const
DPProcessBaseC::OutputType(int) const
DPProcessBaseC::IsStateless(void) const
DPProcessBaseC::OpType(void) const
DPProcessBaseC::operator =(const DPProcessBaseC &)
DPIPortBodyC::Get(void)
DPIPortBodyC::Get(DataT &)
DPIPortBodyC::GetArray(SArray1dC &)
DPIPortBodyC::InputType(void) const
DPIPortBodyC::Save(ostream &) const
DPIPortBodyC::Discard(void)
DPStreamOpBodyC::OpName(void) const
DPStreamOpBodyC::IPlugs(void) const
DPStreamOpBodyC::OPlugs(void) const
DPStreamOpBodyC::IPorts(void) const
DPStreamOpBodyC::OPorts(void) const
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(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
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::Abstract(void)
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
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
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 &)
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)

   DPProcIStreamBodyC<class InT,class OutT>   
 
Convert process into input stream operator, body.
 
include "Ravl/DP/ProcIStream.hh"
Created:06/07/1998 
User Level:Develop
Library:RavlIO
Example:exDataProc.cc
In Scope:RavlN

Parent Classes: Methods:
DPProcIStreamBodyC(const DPProcessC<InT,OutT> & bod,const DPIPortC<InT> & nin)
Constructor.

DPProcIStreamBodyC(const DPProcessC<InT,OutT> & bod)
Constructor.

DPProcIStreamBodyC(const DPProcIStreamBodyC<InT,OutT> & oth)
Copy Constructor.

OutT Get()
Process next piece of data.

bool Get(OutT & outbuff)
Process some data.

IntT GetArray(SArray1dC<OutT> & dest)
Get Array of data.

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

#include "Ravl/DP/Process.hh"
OutT Apply(const InT & dat)
Apply operation.
NB. This may become constant in the future, but the situation isn't clear at the moment.

IntT ApplyArray(const SArray1dC<InT> & in,SArray1dC<OutT> & out)
Streaming version.

const DPProcessC<InT,OutT> operator =(const DPProcessC<InT,OutT> & in)
Assignment operator

const DPProcessC<InT,OutT> Copy() const
Make a copy of this process. Some type defs.

#include "Ravl/DP/StreamOp.hh"
bool IsGetReady() const
Is some data ready ?
true = yes.

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

DPPortC ConnectedTo() const
What does this connect to ?

DListC<DPIPortBaseC> IPorts() const
Input ports.

DListC<DPIPlugBaseC> IPlugs() const
Input plugs.

DPIPortC<InT> & Input()
Access input port.

#include "Ravl/DP/Process.hh"
UIntT NoInputs() const
Get number of inputs.

UIntT NoOutputs() const
Get number of outputs.

const type_info & InputType(int n = 0) const
Get input type.
n is the input number to query, numbering starts from 0.

const type_info & OutputType(int n = 0) const
Get input type.
n is the output number to query, numbering starts from 0.

bool IsStateless() const
Is operation stateless ?

DPProcessBaseBodyC::ProcTypeT OpType() const
Operation type lossy/lossless.

const DPProcessBaseC & operator =(const DPProcessBaseC & oth)
Assignment operator.

#include "Ravl/DP/Port.hh"
OutT 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(OutT & 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<OutT> & 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/StreamOp.hh"
StringC OpName() const
Op type name.

DListC<DPIPlugBaseC> IPlugs() const
Input plugs.

DListC<DPOPlugBaseC> OPlugs() const
Output plugs

DListC<DPIPortBaseC> IPorts() const
Input ports.

DListC<DPOPortBaseC> OPorts() const
Output ports

#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 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/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/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/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)

#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: 06/07/1998, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002