MeVisLab Resolution Independence API
Classes | Public Types | Public Member Functions | List of all members
SbMap< KeyType, ValueType > Class Template Reference

Open Inventor container that associates objects of type KeyType with objects of type ValueType. More...

#include <SbMap.h>

Classes

class  AccessClass
 AccessClass is a temporary class used with the [] operator on an SbMap. More...
 
class  ByLevelIterator
 SbMap::ByLevelIterator for an SbMap, traversing the map top to bottom, level by level left to right.. More...
 
class  Iterator
 Regular low->high (++) and high->low (–) iterator class for an SbMap. More...
 
class  ParentFirstIterator
 SbMap::ParentFirstIterator for an SbMap, traversing the map from top to bottom. More...
 
class  ParentLastIterator
 SbMap::ParentFirstIterator for an SbMap, traversing the map from bottom to top. More...
 

Public Types

typedef SbMapItem< KeyType, ValueType > Node
 

Public Member Functions

 SbMap ()
 
 SbMap (const SbMap &src)
 
 ~SbMap ()
 
SbMap & operator= (const SbMap &src)
 
bool insert (const KeyType &keyNew, const ValueType &v)
 
void set (const KeyType &k, const ValueType &v)
 
bool remove (const KeyType &k)
 
void clear ()
 
bool isEmpty () const
 
Node * find (const KeyType &keyToFind) const
 
Node * getRoot () const
 
unsigned int size () const
 
Iterator getIterator ()
 
ParentFirstIterator getParentFirstIterator ()
 
ParentLastIterator getParentLastIterator ()
 
ByLevelIterator getByLevelIterator ()
 
AccessClass operator[] (const KeyType &k)
 

Detailed Description

template<class KeyType, class ValueType>
class SbMap< KeyType, ValueType >

Open Inventor container that associates objects of type KeyType with objects of type ValueType.

Definition at line 176 of file SbMap.h.

Member Typedef Documentation

◆ Node

template<class KeyType , class ValueType >
typedef SbMapItem<KeyType,ValueType> SbMap< KeyType, ValueType >::Node

Definition at line 180 of file SbMap.h.

Constructor & Destructor Documentation

◆ SbMap() [1/2]

template<class KeyType , class ValueType >
SbMap< KeyType, ValueType >::SbMap ( )
inline

Definition at line 672 of file SbMap.h.

◆ SbMap() [2/2]

template<class KeyType , class ValueType >
SbMap< KeyType, ValueType >::SbMap ( const SbMap< KeyType, ValueType > & src)
inlineexplicit

Definition at line 675 of file SbMap.h.

◆ ~SbMap()

template<class KeyType , class ValueType >
SbMap< KeyType, ValueType >::~SbMap ( )
inline

Definition at line 680 of file SbMap.h.

References SbMap< KeyType, ValueType >::clear().

Member Function Documentation

◆ clear()

template<class KeyType , class ValueType >
void SbMap< KeyType, ValueType >::clear ( )
inline

Definition at line 809 of file SbMap.h.

References SbMap< KeyType, ValueType >::ParentLastIterator::atEnd(), SbMap< KeyType, ValueType >::ParentLastIterator::getNode(), and SbMap< KeyType, ValueType >::getParentLastIterator().

Referenced by SbMap< KeyType, ValueType >::operator=(), and SbMap< KeyType, ValueType >::~SbMap().

◆ find()

template<class KeyType , class ValueType >
Node * SbMap< KeyType, ValueType >::find ( const KeyType & keyToFind) const
inline

Definition at line 829 of file SbMap.h.

References SbMapItem< KeyType, ValueType >::getKey(), SbMapItem< KeyType, ValueType >::getLeftChild(), and SbMapItem< KeyType, ValueType >::getRightChild().

Referenced by SbMap< KeyType, ValueType >::AccessClass::operator ValueType(), SbMap< KeyType, ValueType >::remove(), and SbMap< KeyType, ValueType >::set().

◆ getByLevelIterator()

template<class KeyType , class ValueType >
ByLevelIterator SbMap< KeyType, ValueType >::getByLevelIterator ( )
inline

Definition at line 872 of file SbMap.h.

References SbMap< KeyType, ValueType >::getRoot(), and SbMap< KeyType, ValueType >::size().

◆ getIterator()

template<class KeyType , class ValueType >
Iterator SbMap< KeyType, ValueType >::getIterator ( )
inline

Definition at line 860 of file SbMap.h.

References SbMap< KeyType, ValueType >::getRoot().

◆ getParentFirstIterator()

template<class KeyType , class ValueType >
ParentFirstIterator SbMap< KeyType, ValueType >::getParentFirstIterator ( )
inline

Definition at line 864 of file SbMap.h.

References SbMap< KeyType, ValueType >::getRoot().

Referenced by SbMap< KeyType, ValueType >::operator=().

◆ getParentLastIterator()

template<class KeyType , class ValueType >
ParentLastIterator SbMap< KeyType, ValueType >::getParentLastIterator ( )
inline

Definition at line 868 of file SbMap.h.

References SbMap< KeyType, ValueType >::getRoot().

Referenced by SbMap< KeyType, ValueType >::clear().

◆ getRoot()

template<class KeyType , class ValueType >
Node * SbMap< KeyType, ValueType >::getRoot ( ) const
inline

Definition at line 851 of file SbMap.h.

Referenced by SbMap< KeyType, ValueType >::getByLevelIterator(), SbMap< KeyType, ValueType >::getIterator(), SbMap< KeyType, ValueType >::getParentFirstIterator(), and SbMap< KeyType, ValueType >::getParentLastIterator().

◆ insert()

template<class KeyType , class ValueType >
bool SbMap< KeyType, ValueType >::insert ( const KeyType & keyNew,
const ValueType & v )
inline

Definition at line 694 of file SbMap.h.

References SbMapItem< KeyType, ValueType >::getLeftChild(), SbMapItem< KeyType, ValueType >::getParent(), SbMapItem< KeyType, ValueType >::getRightChild(), SbMap< KeyType, ValueType >::insert(), SbMapItem< KeyType, ValueType >::isLeftChild(), SbMapItem< KeyType, ValueType >::isRed(), SbMapItem< KeyType, ValueType >::isRightChild(), SbMapItem< KeyType, ValueType >::isRoot(), SbMapItem< KeyType, ValueType >::setBlack(), and SbMapItem< KeyType, ValueType >::setRed().

Referenced by SbMap< KeyType, ValueType >::insert(), and SbMap< KeyType, ValueType >::set().

◆ isEmpty()

template<class KeyType , class ValueType >
bool SbMap< KeyType, ValueType >::isEmpty ( ) const
inline

Definition at line 823 of file SbMap.h.

◆ operator=()

template<class KeyType , class ValueType >
SbMap & SbMap< KeyType, ValueType >::operator= ( const SbMap< KeyType, ValueType > & src)
inline

Definition at line 685 of file SbMap.h.

References SbMap< KeyType, ValueType >::clear(), SbMap< KeyType, ValueType >::getParentFirstIterator(), and SbMap< KeyType, ValueType >::set().

◆ operator[]()

template<class KeyType , class ValueType >
AccessClass SbMap< KeyType, ValueType >::operator[] ( const KeyType & k)
inline

Definition at line 878 of file SbMap.h.

◆ remove()

template<class KeyType , class ValueType >
bool SbMap< KeyType, ValueType >::remove ( const KeyType & k)
inline

Definition at line 773 of file SbMap.h.

References SbMap< KeyType, ValueType >::find(), SbMapItem< KeyType, ValueType >::getLeftChild(), SbMapItem< KeyType, ValueType >::getParent(), SbMapItem< KeyType, ValueType >::getRightChild(), SbMapItem< KeyType, ValueType >::isLeftChild(), SbMapItem< KeyType, ValueType >::isRightChild(), SbMapItem< KeyType, ValueType >::setLeftChild(), and SbMapItem< KeyType, ValueType >::setRightChild().

◆ set()

template<class KeyType , class ValueType >
void SbMap< KeyType, ValueType >::set ( const KeyType & k,
const ValueType & v )
inline

Definition at line 762 of file SbMap.h.

References SbMap< KeyType, ValueType >::find(), SbMap< KeyType, ValueType >::insert(), and SbMapItem< KeyType, ValueType >::setValue().

Referenced by SbMap< KeyType, ValueType >::operator=(), and SbMap< KeyType, ValueType >::AccessClass::operator=().

◆ size()

template<class KeyType , class ValueType >
unsigned int SbMap< KeyType, ValueType >::size ( ) const
inline

Definition at line 856 of file SbMap.h.

Referenced by SbMap< KeyType, ValueType >::getByLevelIterator().

The documentation for this class was generated from the following file: