PUBLIC

DPIPlayControlC::DPIPlayControlC(void) DPIPlayControlC::DPIPlayControlC(const DPISPortC &,BooleanT,UIntT,UIntT) DPIPlayControlC::DPIPlayControlC(const DPIPlayControlC &) DPIPlayControlC::Input(void) DPIPlayControlC::Open(const DPISPortC &) DPIPortC::Get(void) DPIPortC::Get(DataT &) DPIPortC::GetArray(SArray1dC &) 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) 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::Save(ostream &) const DPPortC::IsAsync(void) const DPPortC::ConnectedTo(void) const DPPortC::GetAttr(const StringC &,StringC &) DPPortC::SetAttr(const StringC &,const StringC &) RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

DPIPlayControlC<class DataT>
Stream operation handle class.
include	"amma/DP/PlayControl.hh"
User Level:	Default
Library:	MTDataProc
Example:	exFileFormat.cc
Section:	Data Processing
In Scope:	std

Parent Classes:

public DPIPortC<class DataT>
public DPPlayControlC

DPIPlayControlC()

Default Constructor.

DPIPlayControlC(const DPISPortC<DataT> & nin,BooleanT nPassEOS = TRUE,UIntT nstart = ((UIntT)-1),UIntT nend = ((UIntT)-1))

Constructor.

DPIPlayControlC(const DPIPlayControlC<DataT> & oth)

Copy Constructor.

const DPISPortC<DataT> & Input()

Access input port.

BooleanT Open(const DPISPortC<DataT> & nPort)

Open a new input.

DataT Get()

Get next piece of data.

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

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.

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

const type_info & InputType() const

Get type of input port.

BooleanT IsGetReady() const

Is valid data.

BooleanT IsGetEOS() const

Is valid data.

BooleanT Discard()

Discard the next input datum.
returns true on success.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

BooleanT IsAsync() const

Does port work asynchronously ??

DPPortC ConnectedTo() const

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

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

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

RCAbstractC Abstract()

Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const

Save to ostream.

RCHandleAC<DPEntityBodyC> Copy() const

Creat a deep copy of this object.
protected:

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

BooleanT IsValid() const

Check its a valid handle.

BooleanT IsValidObject() const

Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

UIntT Hash() const

Hash function.x

BooleanT IsConst() const

Is object constant ?

BooleanT IsNotConst() const

Is object not constant ?

void SetConst(void) const

Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()

Turn this into an invalid handle.

DPEntityBodyC & Body()

Direct access to body.

const DPEntityBodyC & Body() const

Constant access to body.