PUBLIC

DPProcOStreamBodyC::DPProcOStreamBodyC(const DPProcessC &,const DPOPortC &) DPProcOStreamBodyC::Put(const InT &) DPProcOStreamBodyC::PutArray(SArray1dC &) DPProcessC::Body(void) DPProcessC::Body(void) const DPProcessC::Apply(const InT &) DPProcessC::ApplyArray(const SArray1dC &,SArray1dC &) DPProcessC::operator=(const DPProcessC &) DPProcessC::Copy(void) const DPOStreamOpBodyC::IsPutReady(void) const DPOStreamOpBodyC::PutEOS(void) DPOStreamOpBodyC::ConnectedTo(void) const DPOStreamOpBodyC::Output(void) DPProcessBaseC::Body(void) DPProcessBaseC::Body(void) const DPProcessBaseC::InputType(void) const DPProcessBaseC::OutputType(void) const DPProcessBaseC::IsStateless(void) const DPProcessBaseC::OpType(void) const DPProcessBaseC::operator=(const DPProcessBaseC &) DPOPortBodyC::Put(const DataT &) DPOPortBodyC::PutArray(const SArray1dC &) DPOPortBodyC::OutputType(void) const DPOPortBodyC::Save(ostream &) const DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const DPOPortBaseBodyC::PutEOS(void) DPOPortBaseBodyC::IsPutReady(void) const DPOPortBaseBodyC::OutputType(void) const DPOPortBaseBodyC::Save(ostream &) const RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const DPPortBodyC::IsAsync(void) const DPPortBodyC::Save(ostream &) const DPPortBodyC::ConnectedTo(void) const DPPortBodyC::GetAttr(const StringC &,StringC &) DPPortBodyC::SetAttr(const StringC &,const StringC &) 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 DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

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

Parent Classes:

public DPProcessC<class InT,class OutT>
public DPOStreamOpBodyC<class InT,class OutT>

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.

DPProcessBodyC<InT,OutT> & Body()

Access body.

const DPProcessBodyC<InT,OutT> & Body() const

Access body.

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.

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.

DPProcessBaseBodyC & Body()

Access body.

const DPProcessBaseBodyC & Body() const

Access body.

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.

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.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

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.

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:

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.

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.

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

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.

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.

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.