vtkPaletteElementMap Class Reference

#include <vtkPaletteElementMap.h>

Inheritance diagram for vtkPaletteElementMap:

[legend]Collaboration diagram for vtkPaletteElementMap:

[legend]List of all members.

---

Detailed Description

A map object for elements.

Calls Register when elements are inserted into the map and UnRegister when the element is removed.

Author:

Sean McInerney

Version:

Revision

1.2

Date:

Date

2004/06/12 20:01:23

See also:

vtkExtensionsObjectMap vtkPaletteElement

Definition at line 36 of file vtkPaletteElementMap.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkPaletteElementMap, vtkExtensionsObjectMap)
virtual int	Swap (vtkPaletteElementMap *container)
	Swaps elements of this object with those of the specified container.
vtkPaletteElement *	Find (const char *key) const
	Find the entry in the table with the given key string.
virtual int	Insert (const char *key, vtkPaletteElement *element)
	Insert an element into the table paired with a key string.
virtual const char *	FindKey (const vtkPaletteElement *element)
	Find the first key in the map associated with an element pointer.
vtkPaletteElementMapIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
vtkPaletteElement *	Front (void) const
	Get a read/write pointer to the first element in the map.
virtual int	Front (const char *&key, vtkPaletteElement *&element) const
	Gets the first key - element association in the map.
vtkPaletteElement *	Back (void) const
	Get a read/write pointer to the last element in the map.
virtual int	Back (const char *&key, vtkPaletteElement *&element) const
	Gets the last key - element association in the map.
Static Public Member Functions
vtkPaletteElementMap *	New (void)
Protected Member Functions
	vtkPaletteElementMap (void)
	~vtkPaletteElementMap ()

---

Constructor & Destructor Documentation

vtkPaletteElementMap::vtkPaletteElementMap (  void   )  [inline, protected]

Definition at line 124 of file vtkPaletteElementMap.h.

vtkPaletteElementMap::~vtkPaletteElementMap (   )  [inline, protected]

Definition at line 125 of file vtkPaletteElementMap.h.

---

Member Function Documentation

int vtkPaletteElementMap::Back (  const char *&  key, vtkPaletteElement *&  element )  const [inline, virtual]

Gets the last key - element association in the map. Returns: false if the map is empty or this iterator has not been initialized to traverse any map, otherwise true. Definition at line 167 of file vtkPaletteElementMap.h.

vtkPaletteElement* vtkPaletteElementMap::Back (  void   )  const [inline, virtual]

Get a read/write pointer to the last element in the map. Returns: null if the map is empty, otherwise returns a pointer to an element. Reimplemented from vtkExtensionsObjectMap. Reimplemented in vtkPaletteMap. Definition at line 108 of file vtkPaletteElementMap.h.

vtkPaletteElementMapIterator* vtkPaletteElementMap::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkExtensionsObjectMap. Reimplemented in vtkPaletteMap.

vtkPaletteElement* vtkPaletteElementMap::Find (  const char *  key  )  const [inline, virtual]

Find the entry in the table with the given key string. Parameters: key  A unique string serving as the map key. Returns: The element associated with the specified key if found or NULL if the key is removed, empty, or non-existant. Note: Covariant return type. Reimplemented from vtkExtensionsObjectMap. Reimplemented in vtkPaletteMap. Definition at line 59 of file vtkPaletteElementMap.h.

virtual const char* vtkPaletteElementMap::FindKey (  const vtkPaletteElement *  element  )  [inline, virtual]

Find the first key in the map associated with an element pointer. Returns: true on success, false otherwise. Definition at line 82 of file vtkPaletteElementMap.h.

int vtkPaletteElementMap::Front (  const char *&  key, vtkPaletteElement *&  element )  const [inline, virtual]

Gets the first key - element association in the map. Returns: false if the map is empty or this iterator has not been initialized to traverse any map, otherwise true. Definition at line 157 of file vtkPaletteElementMap.h.

vtkPaletteElement* vtkPaletteElementMap::Front (  void   )  const [inline, virtual]

Get a read/write pointer to the first element in the map. Returns: null if the map is empty, otherwise returns a pointer to an element. Reimplemented from vtkExtensionsObjectMap. Reimplemented in vtkPaletteMap. Definition at line 92 of file vtkPaletteElementMap.h.

virtual int vtkPaletteElementMap::Insert (  const char *  key, vtkPaletteElement *  element )  [inline, virtual]

Insert an element into the table paired with a key string. Parameters: key  A unique string serving as the map key. element  An element to be associated with the key. Exceptions: bad_alloc  Internal use of operator new may throw. overflow_error  Thrown for requests to grow the table beyond its maximum capacity (~ 1<<31). Returns: true for successful additions to the table or false when attempting to insert empty or duplicate strings. Definition at line 74 of file vtkPaletteElementMap.h.

vtkPaletteElementMap* vtkPaletteElementMap::New (  void   )  [static]

Reimplemented from vtkExtensionsObjectMap. Reimplemented in vtkPaletteMap.

virtual int vtkPaletteElementMap::Swap (  vtkPaletteElementMap *  container  )  [inline, virtual]

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false. Definition at line 47 of file vtkPaletteElementMap.h. References Swap().

vtkPaletteElementMap::vtkTypeRevisionMacro (  vtkPaletteElementMap  , vtkExtensionsObjectMap  )

---

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

• vtkPaletteElementMap.h

---