User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Buffers - DPBufferC<class DataT>
 

  PUBLIC
DPBufferC::DPBufferC(void)
DPBufferC::DPBufferC(bool)
DPIOPortC::Copy(void) const
DPIOPortC::In(void)
DPIOPortC::Out(void)
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
DPOPortC::Put(const DataT &)
DPOPortC::PutArray(const SArray1dC &)
DPOPortC::IsPutReady(void) const
DPStreamOpC::OpName(void) const
DPStreamOpC::IPlugs(void) const
DPStreamOpC::OPlugs(void) const
DPStreamOpC::IPorts(void) const
DPStreamOpC::OPorts(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
DPOPortBaseC::PutEOS(void)
DPOPortBaseC::OutputType(void) const
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::GetAttr(const StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::GetAttr(const StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::Abstract(void)
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   DPBufferC<class DataT>   
 
MT safe queue handle.
 
include "Ravl/DP/Buffer.hh"
Created:02/10/1998 
User Level:Normal
Library:RavlDPMT
In Scope:RavlN

Parent Classes: Methods:
DPBufferC()
Default Constructor.
Creates an invalid handle.

DPBufferC(bool nblock)
Constructor.

#include "Ravl/DP/IOPort.hh"
DPIOPortC<DataT,DataT> Copy() const
Make a copy of this process.

DPIPortC<DataT> & In()
Use as input port.
(Get from.)

DPOPortC<DataT> & Out()
Use as output port.
(Put to.)

#include "Ravl/DP/Port.hh"
DataT Get()
Get next piece of data.

bool Get(DataT & buff)
Try and get next piece of data.
If none, return false. else put data into buff.

IntT GetArray(SArray1dC<DataT> & data)
Get an array of data from stream.
returns the number of elements processed.

bool Put(const DataT & dat)
Put data to stream
Returns true if data is put into stream succesfully.

IntT PutArray(const SArray1dC<DataT> & data)
Put an array of data elements into a stream.
returns the number of elements processed from the array.

bool IsPutReady() const
Is port ready for data ?

#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"
const type_info & InputType() const
Get type of input port.

bool IsGetReady() const
Is valid data.

bool IsGetEOS() const
Is valid data.

bool Discard()
Discard the next input datum.
returns true on success.

void PutEOS()
Put End Of Stream marker.

const type_info & OutputType() const
Get type of output port.

#include "Ravl/DP/Entity.hh"
const DPEntityC & operator =(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/DP/Port.hh"
bool IsAsync() const
Does port work asynchronously ??

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.

StringC GetAttr(const StringC & attrName)
Get a stream attribute.
Return the value of an attribute or an empty string if its unkown. 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 IsAsync() const
Does port work asynchronously ??

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.

StringC GetAttr(const StringC & attrName)
Get a stream attribute.
Return the value of an attribute or an empty string if its unkown. 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'.

RCAbstractC Abstract()
Create an abstract handle.

istream & operator >>(istream & strm,RCHandleVC<DPEntityBodyC> & obj)

BinIStreamC & operator >>(BinIStreamC & strm,RCHandleVC<DPEntityBodyC> & obj)

#include "Ravl/DP/Entity.hh"
const DPEntityC & operator =(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/RefCounter.hh"
const RCHandleC<DPEntityBodyC> & operator =(const RCHandleC<DPEntityBodyC> & oth)
Assign handle.

RCHandleC<DPEntityBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<DPEntityBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<DPEntityBodyC> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<DPEntityBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<DPEntityBodyC> & obj)


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