User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Logic - Index - LiteralIndexC<class DataT>
 

  PUBLIC
LiteralIndexC::LiteralIndexC(void)
LiteralIndexC::LiteralIndexC(bool)
LiteralIndexC::Lookup(const LiteralC &,DataT &)
LiteralIndexC::Insert(const LiteralC &,const DataT &)
LiteralIndexC::Access(const LiteralC &)
LiteralIndexC::operator [](const LiteralC &)
LiteralIndexBaseC::Lookup(const LiteralC &)
LiteralIndexBaseC::Insert(const LiteralC &)
LiteralIndexBaseC::Size(void) const
LiteralIndexBaseC::Del(const LiteralC &)
LiteralIndexBaseC::Dump(ostream &,int) const
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::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   LiteralIndexC<class DataT>   
 
Literal index.
 
include "Ravl/Logic/LiteralIndex.hh"
User Level:Normal
Library:RavlLogic
In Scope:RavlLogicN

Comments:
This is an index of 'DataT's based on a Literal key. It maybe queryied directly with 'Lookup' or iterated through for data items matching a pattern with a 'LiteralIndexFilterC'

Parent Classes: Methods:
LiteralIndexC()
Default constructor.
Creates an invalid handle.

LiteralIndexC(bool)
Constructor.

bool Lookup(const LiteralC & key,DataT & val)
Lookup value associated with the key in the index.
if cound copy the value to 'val' and true is return.

bool Insert(const LiteralC & key,const DataT & leaf)
Insert data with given key into index.
Returns false if key already exists.

DataT & Access(const LiteralC & key)
Access data associated with a literal.

DataT & operator [](const LiteralC & key)
Access data associated with a literal.

#include "Ravl/Logic/LiteralIndexBase.hh"
LiteralIndexLeafC Lookup(const LiteralC & key)
Lookup value associated with the key in the index.
returns an invalid handle if not found.

LiteralIndexLeafC Insert(const LiteralC & key)
Insert key into index.
Returns false if key already exists.

SizeT Size() const
Get the number of elements in the index.

bool Del(const LiteralC & key)
Delete key from index.
returns true if key existed, false otherwise.

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

#include "Ravl/RefCounter.hh"
const RCHandleC<LiteralIndexBaseBodyC> & operator =(const RCHandleC<LiteralIndexBaseBodyC> & oth)
Assign handle.

RCHandleC<LiteralIndexBaseBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<LiteralIndexBaseBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<LiteralIndexBaseBodyC> & 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<LiteralIndexBaseBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<LiteralIndexBaseBodyC> & obj)


Maintainer:Charles Galambos, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002