Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - OS - Sequence - Numbered Files - DPOFileSequenceBodyC
 

  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::Save(BinOStreamC &) const
DPEntityBodyC::Copy(void) const
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   DPOFileSequenceBodyC   
 
Input File Sequence
 
include "Ravl/DP/FileSequence.hh"
Created:23/03/1999 
Source file:Ravl/OS/IO/FileSequence.hh
User Level:Develop
Library:RavlOSIO
In Scope:RavlN

Parent Classes: Variables:
FileFormatBaseC format;
Format of input files.

const type_info * saveType;
Type to load.

Methods:
DPOFileSequenceBodyC()
Default constructor.

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

DPOPortBaseC Setup(FileFormatDescC & desc)
Setup for a specific file type.

static bool 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.

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

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

FilenameC Filename() const
Get the filename of the current file.

FilenameC Filename(IntT digs,IntT fno) const
Get the filename of the current file.

bool Next()
Goto next.

FilenameC NextName()
Get filename, and increment counter.

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

bool IsOk() const
Is the file sequence setup ok ?

bool ProbeFormat(FilenameC rootFn)
See if we can find the format.
Returns false if fail.

bool ProbeExample(FilenameC rootFn)
See if we can find the format from an example
Returns false if fail.

bool ProbeTemplate(FilenameC rootFn)
Is the given filename a template for the sequence ?
Returns false if fail.

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

bool ProbeRange(StringC rootFn)
See if we can find the start of the sequence.
Returns false if fail.

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

bool 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

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