User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
SubSequenceSpecC::SubSequenceSpecC(void)
SubSequenceSpecC::SubSequenceSpecC(const FilenameC &,IndexT,IndexT,IntT,const StringC &)
SubSequenceSpecC::SubSequenceSpecC(istream &)
SubSequenceSpecC::SubSequenceSpecC(BinIStreamC &)
SubSequenceSpecC::Save(ostream &) const
SubSequenceSpecC::Save(BinOStreamC &) const
SubSequenceSpecC::Filename(void)
SubSequenceSpecC::Filename(void) const
SubSequenceSpecC::FirstFrame(void)
SubSequenceSpecC::FirstFrame(void) const
SubSequenceSpecC::LastFrame(void)
SubSequenceSpecC::LastFrame(void) const
SubSequenceSpecC::Range(void)
SubSequenceSpecC::Range(void) const
SubSequenceSpecC::ChannelId(void)
SubSequenceSpecC::ChannelId(void) const
SubSequenceSpecC::FileFormat(void) const
SubSequenceSpecC::FileFormat(void)
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
SubSequenceSpecC
 
Specification for sub sequence.
 
include "amma/DP/SubSequenceSpec.hh"
User Level:Default
Library:DataConv
Example:exFileFormat.cc
Section:default.Charles Galambos
In Scope:StdIO

Parent Classes:

Derived Classes: Methods:
SubSequenceSpecC()
Default constructor.
creates an invalid handle.

SubSequenceSpecC(const FilenameC & fn,IndexT firstFrame = 0,IndexT lastFrame = StdConstC::maxInt,IntT nchannelId = 0,const StringC & fmt = StringC())
constructor.

SubSequenceSpecC(istream & is)
Stream constructor.

SubSequenceSpecC(BinIStreamC & is)
BinStream constructor.

BooleanT Save(ostream & os) const
Save to a stream.

BooleanT Save(BinOStreamC & os) const
Save to a BinStream.

FilenameC & Filename()
Access filename.
Name of file where sequence is stored.

const FilenameC & Filename() const
Access filename.
Name of file where sequence is stored.

IndexT & FirstFrame()
Access index of first frame in sequence.

const IndexT & FirstFrame() const
Access index of first frame in sequence.

IndexT & LastFrame()
Access index of last frame in sequence.
If the last frame is ((UIntT) -1), then use the rest of the sequence.

const IndexT & LastFrame() const
Access index of last frame in sequence.
If the last frame is ((UIntT) -1), then use the rest of the sequence.

IndexRangeC & Range()
Access play range.

const IndexRangeC & Range() const
Access play range.

IntT & ChannelId()
Access channel id.

IntT ChannelId() const
Access channel id.

const StringC & FileFormat() const
Access format information.

StringC & FileFormat()
Access format information.

#include "amma/RCHandle.hh"
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<SubSequenceSpecBodyC> & operator=(const RCHandleC<SubSequenceSpecBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<SubSequenceSpecBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<SubSequenceSpecBodyC> & 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.

SubSequenceSpecBodyC & Body()
Direct access to body.

const SubSequenceSpecBodyC & Body() const
Constant access to body.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001