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

  PUBLIC
ArrayStackC::ArrayStackC(void)
ArrayStackC::ArrayStackC(const SizeT)
ArrayStackC::Push(const DataC &)
ArrayStackC::Pop(DataC &)
ArrayStackC::Pop(void)
ArrayStackC::operator<<(const DataC &)
ArrayStackC::operator>>(DataC &)
ArrayStackC::Empty(void)
ArrayStackC::SetEmpty(void)
ArrayStackC::IsEmpty(void) const
ArrayStackC::Copy(void) const
ArrayStackC::Size(void) const
ArrayStackC::Depth(void) const
ArrayStackC::ArrayStack(void) const
ArrayStackC::ArrayStack(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
ArrayStackC<class DataC>
 
Stack, array based.
 
include "amma/ArrStack.hh"
User Level:Default
Library:Marr1
Example:exBuffer.cc
Section:Containers.Stacks
In Scope:std

Comments:
This is good if you know the maximum depth of your stack in advance.

BIG OBJECT

Parent Classes: Methods:
ArrayStackC()
Create an empty handle.
Usefull for arrays etc.

ArrayStackC(const SizeT sizeStack)
Create a stack with the size 'sizeStack'

ArrayStackC<DataC> & Push(const DataC & data)
Push data into the stack

ArrayStackC<DataC> & Pop(DataC & data)
Pop data from the stack

DataC Pop()
Pop data from the stack

ArrayStackC<DataC> & operator<<(const DataC & data)
Push data into the stack

ArrayStackC<DataC> & operator>>(DataC & data)
Pop data from the stack

void Empty()
Empty the stack

ArrayStackC<DataC> & SetEmpty()
Empty the stack

BooleanT IsEmpty() const
Return TRUE if the stack doesn't contain any item

ArrayStackC<DataC> Copy() const
Create a new physical copy of the stack

UIntT Size() const
Get the number of data elements in the stack.

UIntT Depth() const
Get the total size of stack.

const ArrayStackC<DataC> & ArrayStack() const
Access to the stack

ArrayStackC<DataC> & ArrayStack()
Access to the stack

#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<ArrayStackBodyC<DataC>> & operator=(const RCHandleC<ArrayStackBodyC<DataC>> & oth)
Assignment.

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

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

ArrayStackBodyC<DataC> & Body()
Direct access to body.

const ArrayStackBodyC<DataC> & Body() const
Constant access to body.


Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001