Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Internal - DPIStreamOpBodyC<class InT,class OutT>
 

  PUBLIC
DPIStreamOpBodyC::DPIStreamOpBodyC(void)
DPIStreamOpBodyC::DPIStreamOpBodyC(const DPIPortC &)
DPIStreamOpBodyC::DPIStreamOpBodyC(istream &)
DPIStreamOpBodyC::DPIStreamOpBodyC(BinIStreamC &)
DPIStreamOpBodyC::IsGetReady(void) const
DPIStreamOpBodyC::IsGetEOS(void) const
DPIStreamOpBodyC::ConnectedTo(void) const
DPIStreamOpBodyC::IPorts(void) const
DPIStreamOpBodyC::IPlugs(void) const
DPIStreamOpBodyC::Input(void)
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
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
DPPortBodyC::IsAsync(void) const
DPPortBodyC::Save(ostream &) const
DPPortBodyC::ConnectedTo(void) const
DPPortBodyC::GetAttr(const StringC &,StringC &)
DPPortBodyC::SetAttr(const StringC &,const StringC &)
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
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)

   DPIStreamOpBodyC<class InT,class OutT>   
 
Stream operation base class.
 
include "Ravl/DP/StreamOp.hh"
Created:09/07/1998 
Source file:Ravl/Core/IO/StreamOp.hh
User Level:Develop
Library:RavlIO
In Scope:RavlN

Parent Classes: Derived Classes: Variables:
DPIPortC input;
Where to get data from.

Methods:
DPIStreamOpBodyC()
Default constructor.

DPIStreamOpBodyC(const DPIPortC<InT> & nin)
Constructor.

DPIStreamOpBodyC(istream & in)
Stream constructor.

DPIStreamOpBodyC(BinIStreamC & in)
Binary stream constructor.

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<InT> & Input()
Access input port.

#include "Ravl/DP/Port.hh"
OutT 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(OutT & 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<OutT> & 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.

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

#include "Ravl/DP/Port.hh"
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.

#include "Ravl/DP/Entity.hh"
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.

#include "Ravl/DP/Port.hh"
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.

#include "Ravl/RCHandleV.hh"
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.

#include "Ravl/DP/Entity.hh"
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.

#include "Ravl/RefCounter.hh"
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.


Maintainer:Charles Galambos, Created: 09/07/1998, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002