vtkExtensionsObjectMap Class Reference

#include <vtkExtensionsObjectMap.h>

Inheritance diagram for vtkExtensionsObjectMap:

[legend]Collaboration diagram for vtkExtensionsObjectMap:

[legend]List of all members.

---

Detailed Description

A map object for objects.

Calls Register when objects are inserted into the map and UnRegister when the object is removed.

Author:

Sean McInerney

Version:

Revision

1.4

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectMap vtkExtensionsObject

Definition at line 36 of file vtkExtensionsObjectMap.h.

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

---

Constructor & Destructor Documentation

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

Definition at line 124 of file vtkExtensionsObjectMap.h.

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

Definition at line 125 of file vtkExtensionsObjectMap.h.

---

Member Function Documentation

int vtkExtensionsObjectMap::Back (  const char *&  key, vtkExtensionsObject *&  object )  const [inline, virtual]

Gets the last key - object 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 165 of file vtkExtensionsObjectMap.h.

vtkExtensionsObject* vtkExtensionsObjectMap::Back (  void   )  const [inline, virtual]

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

vtkExtensionsObjectMapIterator* vtkExtensionsObjectMap::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectMap. Reimplemented in vtkPaletteElementMap, and vtkPaletteMap.

vtkExtensionsObject* vtkExtensionsObjectMap::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 object associated with the specified key if found or NULL if the key is removed, empty, or non-existant. Note: Covariant return type. Reimplemented from vtkObjectMap. Reimplemented in vtkPaletteElementMap, and vtkPaletteMap. Definition at line 59 of file vtkExtensionsObjectMap.h.

virtual const char* vtkExtensionsObjectMap::FindKey (  const vtkExtensionsObject *  object  )  [inline, virtual]

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

int vtkExtensionsObjectMap::Front (  const char *&  key, vtkExtensionsObject *&  object )  const [inline, virtual]

Gets the first key - object 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 155 of file vtkExtensionsObjectMap.h.

vtkExtensionsObject* vtkExtensionsObjectMap::Front (  void   )  const [inline, virtual]

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

virtual int vtkExtensionsObjectMap::Insert (  const char *  key, vtkExtensionsObject *  object )  [inline, virtual]

Insert an object into the table paired with a key string. Parameters: key  A unique string serving as the map key. object  An object 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 vtkExtensionsObjectMap.h.

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

Reimplemented from vtkObjectMap. Reimplemented in vtkPaletteElementMap, and vtkPaletteMap.

virtual int vtkExtensionsObjectMap::Swap (  vtkExtensionsObjectMap *  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 vtkExtensionsObjectMap.h. References Swap().

vtkExtensionsObjectMap::vtkTypeRevisionMacro (  vtkExtensionsObjectMap  , vtkObjectMap  )

Reimplemented from vtkExtensionsObject.

---

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

• vtkExtensionsObjectMap.h

---