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

  PUBLIC
DPIOPortJoinC::DPIOPortJoinC(void)
DPIOPortJoinC::DPIOPortJoinC(const DPIPortC &,const DPOPortC &,const DPEntityC &)
DPIOPortC::Copy(void) const
DPIOPortC::In(void)
DPIOPortC::Out(void)
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
DPOPortC::Put(const DataT &)
DPOPortC::PutArray(const SArray1dC &)
DPOPortC::IsPutReady(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
DPOPortBaseC::PutEOS(void)
DPOPortBaseC::OutputType(void) const
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
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
RCHandleAC::Abstract(void)
RCHandleAC::IsHandleType(const DT &) const
RCHandleAC::CheckHandleType(const DT &) const
RCHandleAC::Save(ostream &) const
RCHandleAC::Copy(void) const
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
DPIOPortJoinC<class InT,class OutT>
 
Join an IPort and a OPort
 
include "amma/DP/IOJoin.hh"
User Level:Default
Library:DataProc
Example:exDataProc.cc
Section:Data Processing
In Scope:std

Parent Classes:

Methods:
DPIOPortJoinC()
Default constructor.

DPIOPortJoinC(const DPIPortC<InT> & in,const DPOPortC<OutT> & out,const DPEntityC & ahold = DPEntityC(TRUE))
Constructor.

#include "amma/DP/Port.hh"
const DPIOPortC<InT,OutT> Copy() const
Make a copy of this process.

DPIPortC<InT> & In()
Use as input port.
(Get from.)

DPOPortC<OutT> & Out()
Use as output port.
(Put to.)

InT Get()
Get next piece of data.

BooleanT Get(InT & buff)
Try and get next piece of data.
If none, return FALSE. else put data into buff.

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

BooleanT Put(const OutT & dat)
Put data to stream
Returns true if data is put into stream succesfully.

IntT PutArray(const SArray1dC<OutT> & data)
Put an array of data elements into a stream.
returns the number of elements processed from the array.

BooleanT IsPutReady() const
Is port ready for data ?

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.

void PutEOS()
Put End Of Stream marker.

const type_info & OutputType() const
Get type of output port.

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.

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

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


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