Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Data Processing - Seekable Ports - DPIPlayControlC<class DataT>
 

  PUBLIC
DPIPlayControlC::DPIPlayControlC(void)
DPIPlayControlC::DPIPlayControlC(const DPISPortC &,bool,UIntT,UIntT)
DPIPlayControlC::DPIPlayControlC(const DPIPlayControlC &)
DPIPlayControlC::DPIPlayControlC(const DPIPlayControlBodyC &)
DPIPlayControlC::Body(void)
DPIPlayControlC::Body(void) const
DPIPlayControlC::Input(void)
DPIPlayControlC::Open(const DPISPortC &)
DPIPortC::Body(void)
DPIPortC::Body(void) const
DPIPortC::Get(void)
DPIPortC::Get(DataT &)
DPIPortC::GetArray(SArray1dC &)
DPPlayControlC::Body(void)
DPPlayControlC::Body(void) const
DPPlayControlC::LastFrame(void) const
DPPlayControlC::Speed(IntT)
DPPlayControlC::Tell(void) const
DPPlayControlC::Size(void) const
DPPlayControlC::Pause(void)
DPPlayControlC::Continue(void)
DPPlayControlC::Jog(IntT)
DPPlayControlC::Seek(UIntT)
DPPlayControlC::FixedStart(void) const
DPPlayControlC::FixedEnd(void) const
DPPlayControlC::ToBeginning(void)
DPPlayControlC::FastFwd(void)
DPPlayControlC::PlayFwd(void)
DPPlayControlC::Stop(void)
DPPlayControlC::PlayBkw(void)
DPPlayControlC::FastBkw(void)
DPPlayControlC::ToEnd(void)
DPPlayControlC::SeekTo(UIntT)
DPPlayControlC::PlaySubSequence(int,UIntT,UIntT)
DPPlayControlC::SubSeqStart(void)
DPPlayControlC::SubSeqEnd(void)
DPPlayControlC::SubSeqMode(void)
DPStreamOpC::Body(void)
DPStreamOpC::Body(void) const
DPStreamOpC::OpName(void) const
DPStreamOpC::IPlugs(void) const
DPStreamOpC::OPlugs(void) const
DPStreamOpC::IPorts(void) const
DPStreamOpC::OPorts(void) const
DPIPortBaseC::Body(void)
DPIPortBaseC::Body(void) const
DPIPortBaseC::InputType(void) const
DPIPortBaseC::IsGetReady(void) const
DPIPortBaseC::IsGetEOS(void) const
DPIPortBaseC::Discard(void)
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPPortC::Body(void)
DPPortC::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 &)
RCHandleVC::Body(void) const
RCHandleVC::Body(void)
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::Body(void)
RCHandleC::Body(void) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   DPIPlayControlC<class DataT>   
 
Stream operation handle class.
 
include "Ravl/DP/PlayControl.hh"
Created:16/03/99 
Source file:Ravl/OS/DataProc/PlayControl.hh
User Level:Normal
Library:RavlDPMT
In Scope:RavlN

Parent Classes: Methods:
DPIPlayControlC()
Default Constructor.

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

DPIPlayControlC(const DPIPlayControlC<DataT> & oth)
Copy Constructor.

DPIPlayControlC(const DPIPlayControlBodyC<DataT> & bod)
Body constructor.

DPIPlayControlBodyC<DataT> & Body()
Access body.

const DPIPlayControlBodyC<DataT> & Body() const
Access body.

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

bool Open(const DPISPortC<DataT> & nPort)
Open a new input.

#include "Ravl/DP/Port.hh"
DPIPortBodyC<DataT> & Body()
Access body.

const DPIPortBodyC<DataT> & Body() const
Access body.

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.

#include "Ravl/DP/PlayControl.hh"
DPPlayControlBodyC & Body()
Access body.

const DPPlayControlBodyC & Body() const
Access body.

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

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 ?

UIntT Size() const
How long is the stream ?

void Pause()
Pause playing.

void Continue()
Continue playing.

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

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

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 Stop()
Stop (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"
DPStreamOpBodyC & Body()
Access body.

const DPStreamOpBodyC & Body() const
Access body.

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"
DPIPortBaseBodyC & Body()
Access body.

const DPIPortBaseBodyC & Body() const
Access body.

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.

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

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

const DPEntityC & operator =(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/DP/Port.hh"
DPPortBodyC & Body()
Access body.

const DPPortBodyC & Body() const
Access body.

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"
const DPEntityBodyC & Body() const
Constant access to body of object.

DPEntityBodyC & Body()
Constant access to body of object.

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.

DPEntityBodyC & Body()
Access body of object.

const DPEntityBodyC & Body() const
Constant access to body of object.

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