DPIPipeBodyC<class DataT>

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

DPIPipeBaseBodyC

DPIStreamOpBodyC

Methods:

DPIPipeBodyC(const DPEntityC & nhold = DPEntityC(TRUE),FuncT nAuxOp = 0): Default constructor.
DPIPipeBodyC(const DPIPortC<DataT> & port,const DPEntityC & nhold = DPEntityC(TRUE),FuncT nAuxOp = 0): Constructor.
BooleanT SetInput(const DPIPortBaseC & in): Setup input.
BooleanT IsGetReady() const: Is some data ready ?
TRUE = yes.
BooleanT IsGetEOS() const: Has the End Of Stream been reached ?
TRUE = yes.
DataT Get(): Get next piece of data.
May block if not ready.
BooleanT Get(DataT & buff): Get next piece of data.
May block if not ready.
IntT GetArray(SArray1dC<DataT> & data): Get an array of data from stream.
returns the number of elements processed
DPIPortBaseC Port(): Access input port.
BooleanT SetInput(const DPIPortBaseC & in): Setup input.
void SetAuxOperation(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"

BooleanT IsGetReady() const: Is some data ready ?
TRUE = yes.
BooleanT IsGetEOS() const: Has the End Of Stream been reached ?
TRUE = yes.
DPPortC ConnectedTo() const: What does this connect to ?
DPIPortC<DataT> & Input(): Access input port.

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

#include "amma/DP/Port.hh"

DataT 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.
BooleanT Get(DataT & 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<DataT> & 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.
BooleanT Save(ostream & out) const: Save to ostream.
BooleanT Discard(): Discard the next input datum.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/DP/Port.hh"

BooleanT IsGetReady() const: Is some data ready ?
TRUE = yes. Defaults to !IsGetEOS().
BooleanT IsGetEOS() const: Has the End Of Stream been reached ?
TRUE = yes.
const type_info & InputType() const: Input type.
BooleanT Save(ostream & out) const: Save to ostream.
BooleanT Discard(): Discard the next input datum.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#include "amma/DP/Port.hh"

BooleanT IsAsync() const: Does port work asynchronously ?
BooleanT Save(ostream & out) const: Save to ostream.
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/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

DPIPipeBodyC<class DataT>

IPipe body.

include	"amma/DP/Pipes.hh"
User Level:	Default
Library:	DataProc
Example:	exDataProc.cc
Section:	Data Processing.Component
In Scope:	std