vtkObjectBaseMap Class Reference

#include <vtkObjectBaseMap.h>

Inheritance diagram for vtkObjectBaseMap:

[legend]Collaboration diagram for vtkObjectBaseMap:

[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.8

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectBase vtkObjectBaseMapIterator

Definition at line 38 of file vtkObjectBaseMap.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseMap, vtkAbstractMap)
vtkIdType	GetSize (void) const
	Returns the number of elements in the map.
int	IsEmpty (void) const
	Returns true if the map is empty.
vtkIdType	GetMaxSize (void) const
	Returns the maximum size of the map.
void	Clear (void)
	Remove ALL mapped elements.
virtual int	Swap (vtkObjectBaseMap *container)
	Swaps elements of this object with those of the specified container.
vtkIdType	GetCapacity (void) const
	Returns the total number of elements that the map can hold before needing to allocate more memory.
virtual vtkObjectBase *	Find (const char *key) const
	Get a pointer to an object associated with a key.
virtual int	Insert (const char *key, vtkObjectBase *object)
	Insert a pointer to an object associated with a key.
int	Erase (const char *key)
	Removes an association with the specified key.
virtual const char *	FindKey (const vtkObjectBase *object)
	Find the first key in the map associated with an object pointer.
const char *	FindNextKey (void)
	Find the next key in the map associated with the object pointer specified in a previous call to FindKey.
vtkObjectBaseMapIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
vtkObjectBase *	Front (void) const
	Get a read/write pointer to the first object in the container.
int	Front (const char *&key, vtkObjectBase *&object) const
	Gets the first key - object association in the map.
vtkObjectBase *	Back (void) const
	Get a read/write pointer to the last object in the container.
int	Back (const char *&key, vtkObjectBase *&object) const
	Gets the last key - object association in the map.
Static Public Member Functions
vtkObjectBaseMap *	New (void)
Protected Member Functions
	vtkObjectBaseMap (void)
	~vtkObjectBaseMap ()

---

Constructor & Destructor Documentation

vtkObjectBaseMap::vtkObjectBaseMap (  void   )  [protected]

vtkObjectBaseMap::~vtkObjectBaseMap (   )  [protected]

---

Member Function Documentation

int vtkObjectBaseMap::Back (  const char *&  key, vtkObjectBase *&  object )  const [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. Reimplemented from vtkAbstractMap.

vtkObjectBase* vtkObjectBaseMap::Back (  void   )  const [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 vtkContainer. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap.

void vtkObjectBaseMap::Clear (  void   )  [virtual]

Remove ALL mapped elements. Implements vtkContainer.

vtkObjectBaseMapIterator* vtkObjectBaseMap::CreateIterator (  void   )  [virtual]

Create an iterator. Implements vtkAbstractMap. Reimplemented in vtkExtensionsObjectMap, vtkObjectMap, vtkPaletteElementMap, and vtkPaletteMap.

int vtkObjectBaseMap::Erase (  const char *  key  )  [virtual]

Removes an association with the specified key. Returns: true on success, false otherwise. Implements vtkAbstractMap.

virtual vtkObjectBase* vtkObjectBaseMap::Find (  const char *  key  )  const [virtual]

Get a pointer to an object associated with a key. Returns: true on success, false otherwise. Reimplemented from vtkAbstractMap. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap.

virtual const char* vtkObjectBaseMap::FindKey (  const vtkObjectBase *  object  )  [virtual]

Find the first key in the map associated with an object pointer. Returns: true on success, false otherwise. Implements vtkAbstractMap.

const char* vtkObjectBaseMap::FindNextKey (  void   )  [virtual]

Find the next key in the map associated with the object pointer specified in a previous call to FindKey. Returns: true on success, false otherwise. Implements vtkAbstractMap.

int vtkObjectBaseMap::Front (  const char *&  key, vtkObjectBase *&  object )  const [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. Reimplemented from vtkAbstractMap.

vtkObjectBase* vtkObjectBaseMap::Front (  void   )  const [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 vtkContainer. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap.

vtkIdType vtkObjectBaseMap::GetCapacity (  void   )  const [virtual]

Returns the total number of elements that the map can hold before needing to allocate more memory. Reimplemented from vtkAbstractMap.

vtkIdType vtkObjectBaseMap::GetMaxSize (  void   )  const [virtual]

Returns the maximum size of the map. Reimplemented from vtkContainer.

vtkIdType vtkObjectBaseMap::GetSize (  void   )  const [virtual]

Returns the number of elements in the map. Reimplemented from vtkContainer.

virtual int vtkObjectBaseMap::Insert (  const char *  key, vtkObjectBase *  object )  [virtual]

Insert a pointer to an object associated with a key. Returns: true on success, false otherwise. Implements vtkAbstractMap.

int vtkObjectBaseMap::IsEmpty (  void   )  const [virtual]

Returns true if the map is empty. Reimplemented from vtkContainer.

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap.

virtual int vtkObjectBaseMap::Swap (  vtkObjectBaseMap *  container  )  [virtual]

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false.

vtkObjectBaseMap::vtkTypeRevisionMacro (  vtkObjectBaseMap  , vtkAbstractMap  )

---

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

• vtkObjectBaseMap.h

---