PUBLIC

DPOFileSequenceBodyC::DPOFileSequenceBodyC(void) DPOFileSequenceBodyC::DPOFileSequenceBodyC(StringC,UIntT,UIntT,IntT) DPOFileSequenceBodyC::Setup(FileFormatDescC &) DPOFileSequenceBodyC::AuxFunction(DPOPipeBaseC &,DPEntityC &) DPOFileSequenceBodyC::Format(void) DPOFileSequenceBodyC::SaveType(void) const DPFileSequenceBaseBodyC::Seek(UIntT) DPFileSequenceBaseBodyC::DSeek(IntT) DPFileSequenceBaseBodyC::Tell(void) const DPFileSequenceBaseBodyC::Size(void) const DPFileSequenceBaseBodyC::Start(void) const DPFileSequenceBaseBodyC::Filename(void) const DPFileSequenceBaseBodyC::Filename(IntT,IntT) const DPFileSequenceBaseBodyC::Next(void) DPFileSequenceBaseBodyC::NextName(void) DPFileSequenceBaseBodyC::IsElm(void) const DPFileSequenceBaseBodyC::FrameNo(void) const DPFileSequenceBaseBodyC::FrameStart(void) const DPFileSequenceBaseBodyC::FrameEnd(void) const DPFileSequenceBaseBodyC::IsOk(void) const DPFileSequenceBaseBodyC::ProbeFormat(FilenameC) DPFileSequenceBaseBodyC::ProbeExample(FilenameC) DPFileSequenceBaseBodyC::ProbeTemplate(FilenameC) DPFileSequenceBaseBodyC::ProbeImplicit(FilenameC) DPFileSequenceBaseBodyC::ProbeDigits(StringC,StringC,StringC) DPFileSequenceBaseBodyC::ProbeRange(StringC) DPSeekCtrlBodyC::Seek(UIntT) DPSeekCtrlBodyC::DSeek(IntT) DPSeekCtrlBodyC::Tell(void) const DPSeekCtrlBodyC::Size(void) const DPSeekCtrlBodyC::Start(void) const DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

DPOFileSequenceBodyC
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 DPFileSequenceBaseBodyC

FileFormatBaseC format;

Format of input files.

const type_info * saveType;

Type to load.

DPOFileSequenceBodyC()

Default constructor.

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

Constructor.

DPOPortBaseC Setup(FileFormatDescC & desc)

Setup for a specific file type.

BooleanT AuxFunction(DPOPipeBaseC & auxFun,DPEntityC & hold)

Auxilary processing function for pipe.

FileFormatBaseC & Format()

Access files format.

const type_info & SaveType() const

Type of class to load.

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.
May return ((UIntT) (-1)) if not implemented.

UIntT Size() const

Find the total size of the stream.
May return ((UIntT) (-1)) if not implemented.

UIntT Start() const

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

FilenameC Filename() const

Get the filename of the current file.

FilenameC Filename(IntT digs,IntT fno) const

Get the filename of the current file.

BooleanT Next()

Goto next.

FilenameC NextName()

Get filename, and increment counter.

BooleanT IsElm() const

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

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.

BooleanT IsOk() const

Is the file sequence setup ok ?

BooleanT ProbeFormat(FilenameC rootFn)

See if we can find the format.
Returns false if fail.

BooleanT ProbeExample(FilenameC rootFn)

See if we can find the format from an example
Returns false if fail.

BooleanT ProbeTemplate(FilenameC rootFn)

Is the given filename a template for the sequence ?
Returns false if fail.

BooleanT ProbeImplicit(FilenameC rootFn)

Is there a number between the filename and the extention ?
Returns false if fail.

IntT ProbeDigits(StringC dir,StringC prefix,StringC postfix)

See if we can guess the number of digits.
-1=Failed.

BooleanT ProbeRange(StringC rootFn)

See if we can find the start of the sequence.
Returns false if fail.

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

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

void SetUndeletable()

Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.

void ReportInvalidObject(char * Msg = 0) const

Tell user about validation failure.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.