DPProcOStreamBodyC<class InT,class OutT>

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

DPProcessC

DPOStreamOpBodyC

Methods:

DPProcOStreamBodyC(const DPProcessC<InT,OutT> & bod,const DPOPortC<OutT> & nout): Constructor.
BooleanT Put(const InT & dat): Process next piece of data.
IntT PutArray(SArray1dC<InT> & src): Get Array of data.

#include "amma/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 "amma/DP/StreamOp.hh"

BooleanT IsPutReady() const: Is some data ready ?
TRUE = yes.
void PutEOS(): Put End Of Stream marker.
DPPortC ConnectedTo() const: What does this connect to ?
DPOPortC<OutT> & Output(): Access output port.

#include "amma/DP/Process.hh"

const type_info & InputType() const: Get input type.
const type_info & OutputType() const: Get input type.
BooleanT IsStateless() const: Is operation stateless ?
DPProcessBaseBodyC::ProcTypeT OpType() const: Operation type lossy/lossless.
const DPProcessBaseC & operator=(const DPProcessBaseC & oth): Assignment operator.

#include "amma/DP/Port.hh"

BooleanT Put(const InT &): Put data.
This function MUST be provided by client class.
IntT PutArray(const SArray1dC<InT> & data): Put an array of data to stream.
returns number of elements processed. NB. This need NOT be overridden in client classes unless fast handling of arrays of data elements is required.
const type_info & OutputType() const: Input type.
BooleanT Save(ostream & out) const: Save to ostream.

#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"

void PutEOS(): Put End Of Stream marker.
BooleanT IsPutReady() const: Is port ready for data ?
const type_info & OutputType() const: Output type.
BooleanT Save(ostream & out) const: Save to ostream.

#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"

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/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/Entity.hh"

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

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

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

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

DPProcOStreamBodyC<class InT,class OutT>

Wrapped process body.

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