User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
DPIPipeC::DPIPipeC(void)
DPIPipeC::DPIPipeC(const DPEntityC &,DPIPipeBaseBodyC::FuncT)
DPIPipeC::DPIPipeC(const DPIPortC &,const DPEntityC &,DPIPipeBaseBodyC::FuncT)
DPIPipeBaseC::SetInput(const DPIPortBaseC &)
DPIPipeBaseC::SetAuxOperation(DPIPipeBaseBodyC::FuncT)
DPIPipeBaseC::SetStreamStatus(BooleanT,BooleanT)
DPIPipeBaseC::Port(void)
DPIStreamOpC::Input(void)
DPEntityC::operator=(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPEntityC::Save(ostream &) const
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
RCHandleAC::Abstract(void)
RCHandleAC::IsHandleType(const DT &) const
RCHandleAC::CheckHandleType(const DT &) const
RCHandleAC::Save(ostream &) const
RCHandleAC::Copy(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
RCHandleC::IsValid(void) const
RCHandleC::IsValidObject(void) const
RCHandleC::operator=(const RCHandleC &)
RCHandleC::operator==(const RCHandleC &) const
RCHandleC::operator!=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsConst(void) const
RCHandleC::IsNotConst(void) const
RCHandleC::SetConst(void) const
RCHandleC::Invalidate(void)
RCHandleC::Body(void)
RCHandleC::Body(void) const
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
DPEntityC::operator=(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPEntityC::Save(ostream &) const
DPIPipeC<class DataT>
 
IPipe body.
 
include "amma/DP/Pipes.hh"
User Level:Default
Library:DataProc
Example:exDataProc.cc
Section:Data Processing.Component
In Scope:std

Parent Classes:

Methods:
DPIPipeC()
Default constructor.
Creates an invalid handle.

DPIPipeC(const DPEntityC & hold,DPIPipeBaseBodyC::FuncT nAuxOp = 0)
Constructor.

DPIPipeC(const DPIPortC<DataT> & port,const DPEntityC & nhold = DPEntityC(TRUE),DPIPipeBaseBodyC::FuncT nAuxOp = 0)
Constructor.

BooleanT SetInput(const DPIPortBaseC & in)
Setup input.

void SetAuxOperation(DPIPipeBaseBodyC::FuncT nAuxOp)
Set auxilary operation.
This function is called just before any get operation is passed on.

void SetStreamStatus(BooleanT fGR,BooleanT fNEOS)
Set stream status.

DPIPortBaseC Port()
Access input port.

#include "amma/DP/StreamOp.hh"
DPIPortC<DataT> & Input()
Access input port.

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

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const

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

BooleanT 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 "amma/RCHandleA.hh"
RCAbstractC Abstract()
Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

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

RCHandleAC<DPEntityBodyC> Copy() const
Creat a deep copy of this object.
protected:

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

BooleanT IsGetReady() const
Is valid data.

BooleanT IsGetEOS() const
Is valid data.

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

#include "amma/RCHandle.hh"
BooleanT IsValid() const
Check its a valid handle.

BooleanT IsValidObject() const
Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const
Comparison operator.

UIntT Hash() const
Hash function.x

BooleanT IsConst() const
Is object constant ?

BooleanT IsNotConst() const
Is object not constant ?

void SetConst(void) const
Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()
Turn this into an invalid handle.

DPEntityBodyC & Body()
Direct access to body.

const DPEntityBodyC & Body() const
Constant access to body.

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

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

BooleanT 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.

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

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001