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

  PUBLIC
DPIPlayControlBodyC::DPIPlayControlBodyC(void)
DPIPlayControlBodyC::DPIPlayControlBodyC(const DPISPortC &,bool,UIntT,UIntT)
DPIPlayControlBodyC::OpName(void) const
DPIPlayControlBodyC::Get(void)
DPIPlayControlBodyC::Get(DataT &)
DPIPlayControlBodyC::IsGetReady(void) const
DPIPlayControlBodyC::IsGetEOS(void) const
DPIPlayControlBodyC::Open(const DPISPortC &)
DPIPlayControlBodyC::IPorts(void) const
DPIPlayControlBodyC::IPlugs(void) const
DPIPlayControlBodyC::Input(void)
DPIPortBodyC::Get(void)
DPIPortBodyC::Get(DataT &)
DPIPortBodyC::GetArray(SArray1dC &)
DPIPortBodyC::InputType(void) const
DPIPortBodyC::Save(ostream &) const
DPIPortBodyC::Discard(void)
DPPlayControlBodyC::Speed(IntT)
DPPlayControlBodyC::Tell(void) const
DPPlayControlBodyC::LastFrame(void) const
DPPlayControlBodyC::Size(void) const
DPPlayControlBodyC::Seek(UIntT)
DPPlayControlBodyC::Pause(void)
DPPlayControlBodyC::Continue(void)
DPPlayControlBodyC::Jog(IntT)
DPPlayControlBodyC::FixedStart(void) const
DPPlayControlBodyC::FixedEnd(void) const
DPPlayControlBodyC::ToBeginning(void)
DPPlayControlBodyC::FastFwd(void)
DPPlayControlBodyC::PlayFwd(void)
DPPlayControlBodyC::JogFwd(void)
DPPlayControlBodyC::Stop(void)
DPPlayControlBodyC::JogBkw(void)
DPPlayControlBodyC::PlayBkw(void)
DPPlayControlBodyC::FastBkw(void)
DPPlayControlBodyC::ToEnd(void)
DPPlayControlBodyC::SeekTo(UIntT)
DPPlayControlBodyC::PlaySubSequence(int,UIntT,UIntT)
DPPlayControlBodyC::SubSeqStart(void)
DPPlayControlBodyC::SubSeqEnd(void)
DPPlayControlBodyC::SubSeqMode(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
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)

   DPIPlayControlBodyC<class DataT>   
 
Stream operation base class.
 
include "Ravl/DP/PlayControl.hh"
Created:16/03/99 
User Level:Develop
Library:RavlDPMT
In Scope:RavlN

Parent Classes: Variables:
Methods:
DPIPlayControlBodyC()
Default constructor.

DPIPlayControlBodyC(const DPISPortC<DataT> & nin,bool nPassEOS = true,UIntT nstart = ((UIntT)),UIntT nend = ((UIntT)))
Constructor.

StringC OpName() const
Op type name.

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.

bool IsGetReady() const
Is some data ready ?
true = yes.

bool IsGetEOS() const
Has the End Of Stream been reached ?
true = yes.

bool Open(const DPISPortC<DataT> & nPort)
Open new video stream.

DListC<DPIPortBaseC> IPorts() const
Input ports.

DListC<DPIPlugBaseC> IPlugs() const
Input plugs.

const DPISPortC<DataT> & Input()
Access input port.

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

#include "Ravl/DP/PlayControl.hh"
IntT Speed(IntT ninc)
Set increments.
1 == Normal play -1=Reverse play 2=Double speed forward etc..

UIntT Tell() const
Where are we in the stream ?
This gives the number of the NEXT frame that will be processed.

UIntT LastFrame() const
Get number of last frame read.

UIntT Size() const
How long is the stream ?
This is the number of frames in the sequence.

bool Seek(UIntT pos)
Seek to an absolute position in stream

void Pause()
Pause playing.

void Continue()
Continue playing.

void Jog(IntT frames = 1)
Move 'frames' forward or backward.

UIntT FixedStart() const
Get start of sub sequence.

UIntT FixedEnd() const
Get start of sub sequence.

void ToBeginning()
Goto beginning of sequence. (for GUI)

void FastFwd()
Fast forward. (for GUI)

void PlayFwd()
Play forward. (for GUI)

void JogFwd()
Go forward 1 frame. (for GUI)

void Stop()
Stop (for GUI)

void JogBkw()
Go backward 1 frame. (for GUI)

void PlayBkw()
Play backward. (for GUI)

void FastBkw()
Play backward. (for GUI)

void ToEnd()
Goto end of sequence. (for GUI)

void SeekTo(UIntT loc)
Goto position in sequence. (for GUI)

void PlaySubSequence(int mode,UIntT startfrm,UIntT endfrm)
Play a sub-sequence.
0-Once through whole sequence. 1-Once through sub seq. 2-Repeat 3-back and forth.

IntT & SubSeqStart()
Set sub sequence start.

IntT & SubSeqEnd()
Set sub sequence start.

IntT & SubSeqMode()
Set sub sequence start.

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

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: 16/03/99, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002