User Documentation
RAVL, Recognition And Vision Library
Ravl - OS - Sequence - Numbered Files - DPIFileSequenceC

DPIFileSequenceC::DPIFileSequenceC(const DPEntityC &)
DPIFileSequenceC::Setup(FileFormatDescC &)
DPIFileSequenceC::LoadType(void) const
DPFileSequenceBaseC::Filename(void) const
DPFileSequenceBaseC::FrameNo(void) const
DPFileSequenceBaseC::FrameStart(void) const
DPFileSequenceBaseC::FrameEnd(void) const
DPFileSequenceBaseC::IsElm(void) const
DPFileSequenceBaseC::IsOk(void) const
DPSeekCtrlC::Tell(void) const
DPSeekCtrlC::Size(void) const
DPSeekCtrlC::Start(void) const
DPEntityC::operator =(const DPEntityC &)
DPEntityC::Body(void) const
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
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::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

Input File Sequence
include "Ravl/DP/FileSequence.hh"
User Level:Normal
In Scope:RavlN

The filename can now be one of the following, where XXX is the frame number in a multifile sequence. (filename)XXX.(suffix) (filename).(suffix) - The numbers will be inserted in before .(suffix) or a string with '%d' put where digits should be inserted.

Parent Classes: Methods:
Default constructor.
This creates an invalid handle.

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

DPIFileSequenceC(const DPEntityC & obj)
Create form an DPEntityC handle.

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

FileFormatBaseC & Format()
Access files format.

const type_info & LoadType() const
Type of class to load.

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

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.

bool IsElm() const
Check we're at a valid place in the sequence.

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

#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"
const DPEntityC & operator =(const DPEntityC & dat)

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

#include "Ravl/RCHandleV.hh"
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/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.

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