Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Logic - Index - LiteralIndexElementBodyC
 

  PUBLIC
LiteralIndexElementBodyC::LiteralIndexElementBodyC(void)
LiteralIndexElementBodyC::Name(void)
LiteralIndexElementBodyC::Lookup(const TupleC &,LiteralIndexElementC &)
LiteralIndexElementBodyC::Insert(const TupleC &,LiteralIndexElementC &)
LiteralIndexElementBodyC::Filter(const LiteralC &,LiteralIndexElementC &,LiteralC &)
LiteralIndexElementBodyC::Dump(ostream &,int) const
LiteralIndexElementBodyC::Iterator(void)
LiteralIndexElementBodyC::Filter(const LiteralC &)
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)

   LiteralIndexElementBodyC   
 
Index element.
 
include "Ravl/Logic/LiteralIndexElement.hh"
Source file:Ravl/Logic/Index/LiteralIndexElement.hh
User Level:Develop
Library:RavlLogic
In Scope:RavlLogicN

Comments:
This class is an abstract base class for the two types of node found in an index tree, LiteralIndexNodeC and LiteralIndexLeafC.

Parent Classes: Derived Classes: Methods:
LiteralIndexElementBodyC()
Default constructor.

StringC Name()
Get name for element.
usefull for debuging.

bool Lookup(const TupleC & key,LiteralIndexElementC & next)
Lookup next level in tree.
returns true if this level is a leaf and leave next unchanged. if no suitable node is found 'next' is made invalid.

bool Insert(const TupleC & key,LiteralIndexElementC & next)
Insert/Replace element into the node.

LiteralMapIterC<LiteralIndexElementC> Filter(const LiteralC & key,LiteralIndexElementC & next,LiteralC & var)
Filter next level in tree.
If there's a choice return an iterator otherwise the next branch in the tree is assigned to 'next'. var is the variable to witch the value of the iterator should be bound.

void Dump(ostream & out,int level = 0) const
Dump index in human readable form.
For debugging only.

LiteralMapIterC<LiteralIndexElementC> Iterator()
Access iterator for all branches from this node.

LiteralMapIterC<LiteralIndexElementC> Filter(const LiteralC & filt)
Access iterator for all branches from this node matching filter filt.

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


Documentation by CxxDoc: Tue Aug 13 09:59:30 2002