PUBLIC

DPIPipeBodyC::DPIPipeBodyC(const DPEntityC &,FuncT) DPIPipeBodyC::DPIPipeBodyC(const DPIPortC &,const DPEntityC &,FuncT) DPIPipeBodyC::SetInput(const DPIPortBaseC &) DPIPipeBodyC::IsGetReady(void) const DPIPipeBodyC::IsGetEOS(void) const DPIPipeBodyC::Get(void) DPIPipeBodyC::Get(DataT &) DPIPipeBodyC::GetArray(SArray1dC &) DPIPipeBodyC::Port(void) DPIPipeBaseBodyC::SetInput(const DPIPortBaseC &) DPIPipeBaseBodyC::SetAuxOperation(FuncT) DPIPipeBaseBodyC::SetStreamStatus(bool,bool) DPIPipeBaseBodyC::Port(void) DPIStreamOpBodyC::IsGetReady(void) const DPIStreamOpBodyC::IsGetEOS(void) const DPIStreamOpBodyC::ConnectedTo(void) const DPIStreamOpBodyC::IPorts(void) const DPIStreamOpBodyC::IPlugs(void) const DPIStreamOpBodyC::Input(void) DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Save(BinOStreamC &) const DPEntityBodyC::Copy(void) const DPIPortBodyC::Get(void) DPIPortBodyC::Get(DataT &) DPIPortBodyC::GetArray(SArray1dC &) DPIPortBodyC::InputType(void) const DPIPortBodyC::Save(ostream &) const DPIPortBodyC::Discard(void) DPStreamOpBodyC::OpName(void) const DPStreamOpBodyC::IPlugs(void) const DPStreamOpBodyC::OPlugs(void) const DPStreamOpBodyC::IPorts(void) const DPStreamOpBodyC::OPorts(void) const RCBodyVC::Save(ostream &) const RCBodyVC::Save(BinOStreamC &) const RCBodyVC::Copy(void) const RCBodyVC::DeepCopy(UIntT) const DPIPortBaseBodyC::IsGetReady(void) const DPIPortBaseBodyC::IsGetEOS(void) const DPIPortBaseBodyC::InputType(void) const DPIPortBaseBodyC::Save(ostream &) const DPIPortBaseBodyC::Discard(void) DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Save(BinOStreamC &) const DPEntityBodyC::Copy(void) const RCBodyC::References(void) const RCBodyC::Copy(void) const RCBodyC::DeepCopy(UIntT) const RCBodyC::IncRefCounter(void) RCBodyC::DecRefCounter(void) DPPortBodyC::IsAsync(void) const DPPortBodyC::Save(ostream &) const DPPortBodyC::ConnectedTo(void) const DPPortBodyC::GetAttr(const StringC &,StringC &) DPPortBodyC::SetAttr(const StringC &,const StringC &) DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Save(BinOStreamC &) const DPEntityBodyC::Copy(void) const

public DPIPipeBaseBodyC
public DPIStreamOpBodyC<DataT,DataT>

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.

bool SetInput(const DPIPortBaseC & in)

Setup input.

bool IsGetReady() const

Is some data ready ?
true = yes.

bool IsGetEOS() const

Has the End Of Stream been reached ?
true = yes.

DataT Get()

Get next piece of data.
May block if not ready.

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

bool 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(bool fGR,bool fNEOS)

Set stream status.

DPIPortBaseC Port()

Access input port.

bool IsGetReady() const

Is some data ready ?
true = yes.

bool IsGetEOS() const

Has the End Of Stream been reached ?
true = yes.

DPPortC ConnectedTo() const

What does this connect to ?

DListC<DPIPortBaseC> IPorts() const

Input ports.

DListC<DPIPlugBaseC> IPlugs() const

Input plugs.

DPIPortC<DataT> & Input()

Access input port.

bool Save(ostream & out) const

Save to ostream.

bool Save(BinOStreamC & out) const

Save to binary stream.

RCBodyVC & Copy() const

Creat a copy of this object.

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.

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

bool Save(ostream & out) const

Save to ostream.

bool Discard()

Discard the next input datum.

StringC OpName() const

Op type name.

DListC<DPIPlugBaseC> IPlugs() const

Input plugs.

DListC<DPOPlugBaseC> OPlugs() const

Output plugs

DListC<DPIPortBaseC> IPorts() const

Input ports.

DListC<DPOPortBaseC> OPorts() const

Output ports

bool Save(ostream & out) const

Save to stream 'out'.

bool Save(BinOStreamC & out) const

Save to binary stream 'out'.

RCBodyVC & Copy() const

Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const

Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

bool IsGetReady() const

Is some data ready ?
true = yes. Defaults to !IsGetEOS().

bool IsGetEOS() const

Has the End Of Stream been reached ?
true = yes.

const type_info & InputType() const

Input type.

bool Save(ostream & out) const

Save to ostream.

bool Discard()

Discard the next input datum.

bool Save(ostream & out) const

Save to ostream.

bool Save(BinOStreamC & out) const

Save to binary stream.

RCBodyVC & Copy() const

Creat a copy of this object.

UIntT References() const

Access count of handles open to this object.

RCBodyC & Copy() const

Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const

Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()

Increment reference counter.

bool DecRefCounter()

Decrement reference counter.

bool IsAsync() const

Does port work asynchronously ?

bool Save(ostream & out) const

Save to ostream.

DPPortC ConnectedTo() const

Is this port connected to another ?
If not returns invalid handle.

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

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

bool Save(ostream & out) const

Save to ostream.

bool Save(BinOStreamC & out) const

Save to binary stream.

RCBodyVC & Copy() const

Creat a copy of this object.