vtkObjectMap Class Reference

#include <vtkObjectMap.h>

Inheritance diagram for vtkObjectMap:

[legend]Collaboration diagram for vtkObjectMap:

[legend]List of all members.

---

Detailed Description

A map container for objects.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/06/24 23:17:16

See also:

vtkObjectBaseMap vtkObject

Definition at line 31 of file vtkObjectMap.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectMap, vtkObjectBaseMap)
void	PrintSelf (ostream &, vtkIndent)
virtual int	Swap (vtkObjectMap *container)
	Swaps items of this container with those of the specified container.
virtual int	Copy (vtkObjectMap *container)
	Copy all items from the specified container into this container.
vtkObject *	Find (const char *key) const
	Find the item in the table with the given key string.
virtual int	Insert (const char *key, vtkObject *item)
	Insert an item into the table paired with a key string.
vtkObjectMapIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
vtkObject *	Front (void) const
	Returns the first item in the container, or null if the container is empty.
virtual int	Front (const char *&key, vtkObject *&item) const
	Gets the first key - item association in the map.
vtkObject *	Back (void) const
	Returns the last item in the container, or null if the container is empty.
virtual int	Back (const char *&key, vtkObject *&item) const
	Gets the last key - item association in the map.
Static Public Member Functions
vtkObjectMap *	New (void)
Protected Member Functions
	vtkObjectMap (void)
	~vtkObjectMap ()

---

Constructor & Destructor Documentation

vtkObjectMap::vtkObjectMap (  void   )  [protected]

vtkObjectMap::~vtkObjectMap (   )  [protected]

---

Member Function Documentation

int vtkObjectMap::Back (  const char *&  key, vtkObject *&  item )  const [inline, virtual]

Gets the last key - item association in the map. Returns: false if the map is empty, otherwise true. Definition at line 153 of file vtkObjectMap.h.

vtkObject* vtkObjectMap::Back (  void   )  const [inline, virtual]

Returns the last item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseMap. Definition at line 95 of file vtkObjectMap.h.

virtual int vtkObjectMap::Copy (  vtkObjectMap *  container  )  [inline, virtual]

Copy all items from the specified container into this container. Returns: true on success, otherwise false. Definition at line 50 of file vtkObjectMap.h.

vtkObjectMapIterator* vtkObjectMap::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectBaseMap.

vtkObject* vtkObjectMap::Find (  const char *  key  )  const [inline, virtual]

Find the item in the table with the given key string. Parameters: key  A unique string serving as the map key. Returns: The item associated with the specified key if found or NULL if the key is removed, empty, or non-existant. Reimplemented from vtkObjectBaseMap. Definition at line 60 of file vtkObjectMap.h.

int vtkObjectMap::Front (  const char *&  key, vtkObject *&  item )  const [inline, virtual]

Gets the first key - item association in the map. Returns: false if the map is empty, otherwise true. Definition at line 143 of file vtkObjectMap.h.

vtkObject* vtkObjectMap::Front (  void   )  const [inline, virtual]

Returns the first item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseMap. Definition at line 81 of file vtkObjectMap.h.

virtual int vtkObjectMap::Insert (  const char *  key, vtkObject *  item )  [inline, virtual]

Insert an item into the table paired with a key string. Parameters: key  A unique string serving as the map key. item  An object to be associated with the key. Returns: true for successful additions to the table or false when attempting to insert empty or duplicate strings. Definition at line 71 of file vtkObjectMap.h.

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

Reimplemented from vtkObjectBaseMap.

void vtkObjectMap::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkObjectBaseMap.

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

Swaps items of this container with those of the specified container. Returns: true on success, otherwise false. Definition at line 43 of file vtkObjectMap.h.

vtkObjectMap::vtkTypeRevisionMacro (  vtkObjectMap  , vtkObjectBaseMap  )

---

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

• vtkObjectMap.h

---