PUBLIC

DPOFileSequenceC::DPOFileSequenceC(void) DPOFileSequenceC::DPOFileSequenceC(StringC,UIntT,UIntT,IntT) DPOFileSequenceC::DPOFileSequenceC(const DPEntityC &) DPOFileSequenceC::Setup(FileFormatDescC &) DPOFileSequenceC::Format(void) DPOFileSequenceC::SaveType(void) const DPFileSequenceBaseC::Filename(void) const DPFileSequenceBaseC::FrameNo(void) const DPFileSequenceBaseC::FrameStart(void) const DPFileSequenceBaseC::FrameEnd(void) const DPFileSequenceBaseC::NextName(void) DPFileSequenceBaseC::IsElm(void) const DPFileSequenceBaseC::IsOk(void) const DPSeekCtrlC::Seek(UIntT) DPSeekCtrlC::DSeek(IntT) DPSeekCtrlC::Tell(void) const DPSeekCtrlC::Size(void) const DPSeekCtrlC::Start(void) const DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) 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

DPOFileSequenceC
Input File Sequence
include	"amma/DP/FileSeq.hh"
User Level:	Default
Library:	DataConv
Example:	exFileFormat.cc
Section:	Data Processing.Component
In Scope:	std

Parent Classes:

public DPFileSequenceBaseC

DPOFileSequenceC()

Default constructor.
This creates an invalid handle.

DPOFileSequenceC(StringC fn,UIntT start = ((UIntT)-1),UIntT end = ((UIntT)-1),IntT digits = -1)

Constructor.

DPOFileSequenceC(const DPEntityC & obj)

Create form an DPEntityC handle.

DPOPortBaseC Setup(FileFormatDescC & desc)

Setup for a specific file type.

FileFormatBaseC & Format()

Access files format.

const type_info & SaveType() const

Type of class to load.

FilenameC Filename() const

Get the filename of the current file.

UIntT FrameNo() const

Get current frame no.

UIntT FrameStart() const

Get start frame no.

UIntT FrameEnd() const

Get final frame no.
((UIntT) -1) is given if not known.

FilenameC NextName()

Get next filename, then increment counter.

BooleanT IsElm() const

Check we're at a valid place in the sequence.

BooleanT IsOk() const

Is the file sequence setup ok ?

BooleanT Seek(UIntT off)

Seek to location in stream.
Returns FALSE, if seek failed. (Maybe because its not implemented.) if an error occurered (Seek returned False) then stream position will not be changed.

BooleanT DSeek(IntT off)

Delta Seek, goto location relative to the current one.
The default behavour of this functions is : Do some error checking then: Seek((UIntT)((IntT) Tell() + off)); if an error occurered (DSeek returned False) then stream position will not be changed.

UIntT Tell() const

Find current location in stream.
Defined as the index of the next object to be written or read. May return ((UIntT) (-1)) if not implemented.

UIntT Size() const

Find the total size of the stream. (assuming it starts from 0)
May return ((UIntT) (-1)) if not implemented.

UIntT Start() const

Find the offset where the stream begins, normally zero.
Defaults to 0

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

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:

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.