vtkExtensionsObjectCollection Class Reference

#include <vtkExtensionsObjectCollection.h>

Inheritance diagram for vtkExtensionsObjectCollection:

[legend]Collaboration diagram for vtkExtensionsObjectCollection:

[legend]List of all members.

---

Detailed Description

A list of objects.

vtkExtensionsObjectCollection is an object that creates and manipulates lists of objects. The list is not ordered, but duplicate entries can be prevented.

Author:

Sean McInerney

Version:

Revision

1.2

Date:

Date

2004/08/10 07:37:21

See also:

vtkUniqueCollection vtkExtensionsObject

Definition at line 39 of file vtkExtensionsObjectCollection.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkExtensionsObjectCollection, vtkUniqueCollection)
void	PrintSelf (ostream &, vtkIndent)
void	AddItem (vtkExtensionsObject *object)
	Add an object to the list.
void	RemoveAllItems (void)
	Remove all objects from the list.
int	IndexOf (vtkExtensionsObject *object)
	Returns index of object in the list or -1 if not found.
int	IsItemPresent (vtkExtensionsObject *object)
	Determine whether a particular object is present within the list.
vtkExtensionsObject *	GetNextItem (void)
	Get the next object in the list.
vtkExtensionsObject *	GetItem (int i)
	Get the i'th object in the list.
vtkExtensionsObject *	GetFirstItem (void)
	Get the first object in the list.
vtkExtensionsObject *	GetLastItem (void)
	Get the last object in the list.
int	PrependItem (vtkExtensionsObject *object)
	Insert an object to the front of the list (like a push).
int	AppendItem (vtkExtensionsObject *object)
	Append an object to the end of the list (like a push_back).
int	InsertItemAt (vtkExtensionsObject *object, int i)
	Insert object at the i'th position.
void	ReplaceItem (int i, vtkExtensionsObject *object, vtkExtensionsObject **replaced)
	Replace the i'th object in the list.
void	ReplaceItem (int i, vtkExtensionsObject *object)
	Replace the i'th object in the list.
void	RemoveItem (int i, vtkExtensionsObject **removed)
	Remove the i'th object in the list.
void	RemoveItem (int i)
	Remove the i'th object in the list.
void	RemoveItem (vtkExtensionsObject *object, vtkExtensionsObject **removed)
	Remove an object from the list.
void	RemoveItem (vtkExtensionsObject *object)
	Remove an object from the list.
void	RemoveLastItem (vtkExtensionsObject **removed)
	Remove the last object in the list (like a stack pop).
void	RemoveLastItem (void)
	Remove the last object in the list (like a stack pop).
Static Public Member Functions
vtkExtensionsObjectCollection *	New (void)
Protected Member Functions
	vtkExtensionsObjectCollection (void)
	~vtkExtensionsObjectCollection ()

---

Constructor & Destructor Documentation

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

Definition at line 152 of file vtkExtensionsObjectCollection.h.

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

Definition at line 153 of file vtkExtensionsObjectCollection.h.

---

Member Function Documentation

void vtkExtensionsObjectCollection::AddItem (  vtkExtensionsObject *  object  )

Add an object to the list.

int vtkExtensionsObjectCollection::AppendItem (  vtkExtensionsObject *  object  )

Append an object to the end of the list (like a push_back).

vtkExtensionsObject* vtkExtensionsObjectCollection::GetFirstItem (  void   )

Get the first object in the list. Returns: The first object or NULL if the list is empty. Reimplemented from vtkUniqueCollection.

vtkExtensionsObject* vtkExtensionsObjectCollection::GetItem (  int  i  )

Get the i'th object in the list. Returns: The i'th object or NULL if index is out of range. Reimplemented from vtkUniqueCollection.

vtkExtensionsObject* vtkExtensionsObjectCollection::GetLastItem (  void   )

Get the last object in the list. Returns: The last object or NULL if the list is empty. Reimplemented from vtkUniqueCollection.

vtkExtensionsObject* vtkExtensionsObjectCollection::GetNextItem (  void   )

Get the next object in the list. Returns: The next object or NULL when the collection is exhausted. Reimplemented from vtkUniqueCollection.

int vtkExtensionsObjectCollection::IndexOf (  vtkExtensionsObject *  object  )

Returns index of object in the list or -1 if not found.

int vtkExtensionsObjectCollection::InsertItemAt (  vtkExtensionsObject *  object, int  i )

Insert object at the i'th position.

int vtkExtensionsObjectCollection::IsItemPresent (  vtkExtensionsObject *  object  )

Determine whether a particular object is present within the list. Returns: The position of the first matching object entry in the list.

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

Reimplemented from vtkUniqueCollection.

int vtkExtensionsObjectCollection::PrependItem (  vtkExtensionsObject *  object  )

Insert an object to the front of the list (like a push).

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

Reimplemented from vtkUniqueCollection.

void vtkExtensionsObjectCollection::RemoveAllItems (  void   )  [inline]

Remove all objects from the list. Reimplemented from vtkCollection. Definition at line 97 of file vtkExtensionsObjectCollection.h. References vtkCollection::RemoveAllItems().

void vtkExtensionsObjectCollection::RemoveItem (  vtkExtensionsObject *  object  )  [inline]

Remove an object from the list. If no object found, list is unaffected. See warning in description of RemoveItem(int). Note: The removed item may be returned in optional second call parameter. Definition at line 92 of file vtkExtensionsObjectCollection.h.

void vtkExtensionsObjectCollection::RemoveItem (  vtkExtensionsObject *  object, vtkExtensionsObject **  removed )

Remove an object from the list. If no object found, list is unaffected. See warning in description of RemoveItem(int). Note: The removed item may be returned in optional second call parameter.

void vtkExtensionsObjectCollection::RemoveItem (  int  i  )  [inline]

Remove the i'th object in the list. Be careful if using this function during traversal of the list using GetNextItem. The list WILL be shortened if a valid index is given! Note: The removed item may be returned in optional second call parameter. Reimplemented from vtkUniqueCollection. Definition at line 76 of file vtkExtensionsObjectCollection.h.

void vtkExtensionsObjectCollection::RemoveItem (  int  i, vtkExtensionsObject **  removed )

Remove the i'th object in the list. Be careful if using this function during traversal of the list using GetNextItem. The list WILL be shortened if a valid index is given! Note: The removed item may be returned in optional second call parameter.

void vtkExtensionsObjectCollection::RemoveLastItem (  void   )  [inline]

Remove the last object in the list (like a stack pop). Reimplemented from vtkUniqueCollection. Definition at line 138 of file vtkExtensionsObjectCollection.h. References vtkUniqueCollection::RemoveLastItem().

void vtkExtensionsObjectCollection::RemoveLastItem (  vtkExtensionsObject **  removed  )

Remove the last object in the list (like a stack pop).

void vtkExtensionsObjectCollection::ReplaceItem (  int  i, vtkExtensionsObject *  object )  [inline]

Replace the i'th object in the list. Note: The replaced item may be returned in optional third call parameter. Definition at line 60 of file vtkExtensionsObjectCollection.h.

void vtkExtensionsObjectCollection::ReplaceItem (  int  i, vtkExtensionsObject *  object, vtkExtensionsObject **  replaced )

Replace the i'th object in the list. Note: The replaced item may be returned in optional third call parameter.

vtkExtensionsObjectCollection::vtkTypeRevisionMacro (  vtkExtensionsObjectCollection  , vtkUniqueCollection  )

---

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

• vtkExtensionsObjectCollection.h

---