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

  PUBLIC
EditSpecC::EditSpecC(void)
EditSpecC::EditSpecC(const SubSequenceSpecC &,const IndexRangeC &)
EditSpecC::EditSpecC(const FilenameC &,IndexT,IndexT,IntT,const StringC &,const IndexRangeC &)
EditSpecC::EditSpecC(EditSpecBodyC &)
EditSpecC::Body(void)
EditSpecC::Body(void) const
EditSpecC::InsertRange(void)
EditSpecC::InsertRange(void) const
EditSpecC::operator==(const EditSpecC &) const
EditSpecC::operator!=(const EditSpecC &) const
SubSequenceSpecC::Body(void)
SubSequenceSpecC::Body(void) const
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
EditSpecC
 
Edit spec.
 
include "amma/DP/EditSpec.hh"
User Level:Default
Library:DataConv
Example:exFileFormat.cc
Section:default.Charles Galambos
In Scope:StdIO

Comments:
Includes where a SubSequence fits into a larger composite sequence.

Parent Classes: Methods:
EditSpecC()
Default constructor
creates an invalid handle.

EditSpecC(const SubSequenceSpecC & from,const IndexRangeC & ins = IndexRangeC(0,0))
Constructor.

EditSpecC(const FilenameC & nfn,IndexT nfirstFrame = 0,IndexT nlastFrame = StdConstC::maxInt,IntT nchannelId = 0,const StringC & fmt = StringC(),const IndexRangeC & ins = IndexRangeC(0,StdConstC::maxInt))
Constructor from elements.

EditSpecC(EditSpecBodyC & bod)
Body constructor.

EditSpecBodyC & Body()
Access body.

const EditSpecBodyC & Body() const
Access body.

IndexRangeC & InsertRange()
The location of the sequence in an output range.

const IndexRangeC & InsertRange() const
The location of the sequence in an output range.

BooleanT operator==(const EditSpecC & es) const
The same edit ?

BooleanT operator!=(const EditSpecC & es) const
The same edit ?

#include "amma/DP/SubSequenceSpec.hh"
SubSequenceSpecBodyC & Body()
Access body.

const SubSequenceSpecBodyC & Body() const
Access body.

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:49:27 2001