vtkCollection Class Reference

#include <vtkCollection.h>

Inheritance diagram for vtkCollection:

Inheritance graph
Collaboration diagram for vtkCollection:

Collaboration graph

List of all members.

Detailed Description

create and manipulate unsorted lists of objects

vtkCollection is a general object for creating and manipulating lists of objects. The lists are unsorted and allow duplicate entries. vtkCollection also serves as a base class for lists of specific types of objects.

See also:
vtkActorCollection vtkAssemblyPaths vtkDataSetCollection vtkImplicitFunctionCollection vtkLightCollection vtkPolyDataCollection vtkRenderWindowCollection vtkRendererCollection vtkStructuredPointsCollection vtkTransformCollection vtkVolumeCollection

Definition at line 48 of file vtkCollection.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddItem (vtkObject *)
void InsertItem (int i, vtkObject *)
void ReplaceItem (int i, vtkObject *)
void RemoveItem (int i)
void RemoveItem (vtkObject *)
void RemoveAllItems ()
int IsItemPresent (vtkObject *a)
int GetNumberOfItems ()
void InitTraversal ()
vtkObjectGetNextItemAsObject ()
vtkObjectGetItemAsObject (int i)
vtkCollectionIteratorNewIterator ()
void InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkCollectionSafeDownCast (vtkObject *o)
static vtkCollectionNew ()

Protected Member Functions

 vtkCollection ()
 ~vtkCollection ()
virtual void DeleteElement (vtkCollectionElement *)
virtual void ReportReferences (vtkGarbageCollector *collector)

Protected Attributes

int NumberOfItems


class vtkCollectionIterator

Member Typedef Documentation

Constructor & Destructor Documentation

vtkCollection::vtkCollection (  )  [protected]

vtkCollection::~vtkCollection (  )  [protected]

Member Function Documentation

virtual const char* vtkCollection::GetClassName (  )  [virtual]

static int vtkCollection::IsTypeOf ( const char *  name  )  [static]

virtual int vtkCollection::IsA ( const char *  name  )  [virtual]

static vtkCollection* vtkCollection::SafeDownCast ( vtkObject o  )  [static]

void vtkCollection::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkAssemblyPath, vtkSocketCollection, vtkExecutiveCollection, vtkPolyDataCollection, vtkStructuredPointsCollection, vtkImageReader2Collection, vtkActorCollection, vtkCullerCollection, vtkLightCollection, vtkMapperCollection, vtkProp3DCollection, vtkRendererCollection, vtkRenderPassCollection, vtkRenderWindowCollection, vtkShader2Collection, and vtkVolumeCollection.

static vtkCollection* vtkCollection::New (  )  [static]

void vtkCollection::AddItem ( vtkObject  ) 

Add an object to the list. Does not prevent duplicate entries.

void vtkCollection::InsertItem ( int  i,

Insert item into the list after the i'th item. Does not prevent duplicate entries. If i < 0 the item is placed at the top of the list.

void vtkCollection::ReplaceItem ( int  i,

Replace the i'th item in the collection with a

Reimplemented in vtkSocketCollection.

void vtkCollection::RemoveItem ( int  i  ) 

Remove the i'th item in the list. Be careful if using this function during traversal of the list using GetNextItemAsObject (or GetNextItem in derived class). The list WILL be shortened if a valid index is given! If this->Current is equal to the element being removed, have it point to then next element in the list.

Reimplemented in vtkSocketCollection.

void vtkCollection::RemoveItem ( vtkObject  ) 

Remove an object from the list. Removes the first object found, not all occurrences. If no object found, list is unaffected. See warning in description of RemoveItem(int).

Reimplemented in vtkSocketCollection.

void vtkCollection::RemoveAllItems (  ) 

Remove all objects from the list.

Reimplemented in vtkSocketCollection.

int vtkCollection::IsItemPresent ( vtkObject a  ) 

Search for an object and return location in list. If the return value is 0, the object was not found. If the object was found, the location is the return value-1.

int vtkCollection::GetNumberOfItems (  ) 

Return the number of objects in the list.

void vtkCollection::InitTraversal (  )  [inline]

Initialize the traversal of the collection. This means the data pointer is set at the beginning of the list.

Definition at line 93 of file vtkCollection.h.

void vtkCollection::InitTraversal ( vtkCollectionSimpleIterator cookie  )  [inline]

A reentrant safe way to iterate through a collection. Just pass the same cookie value around each time

Definition at line 99 of file vtkCollection.h.

vtkObject * vtkCollection::GetNextItemAsObject (  )  [inline]

Get the next item in the collection. NULL is returned if the collection is exhausted.

Definition at line 150 of file vtkCollection.h.

vtkObject* vtkCollection::GetItemAsObject ( int  i  ) 

Get the i'th item in the collection. NULL is returned if i is out of range

vtkObject * vtkCollection::GetNextItemAsObject ( vtkCollectionSimpleIterator cookie  )  [inline]

A reentrant safe way to get the next object as a collection. Just pass the same cookie back and forth.

Definition at line 165 of file vtkCollection.h.

vtkCollectionIterator* vtkCollection::NewIterator (  ) 

Get an iterator to traverse the objects in this collection.

virtual void vtkCollection::Register ( vtkObjectBase o  )  [virtual]

Participate in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkCollection::UnRegister ( vtkObjectBase o  )  [virtual]

Participate in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkCollection::DeleteElement ( vtkCollectionElement  )  [protected, virtual]

Reimplemented in vtkActor2DCollection.

virtual void vtkCollection::ReportReferences ( vtkGarbageCollector collector  )  [protected, virtual]

Reimplemented from vtkObjectBase.

Friends And Related Function Documentation

friend class vtkCollectionIterator [friend]

Definition at line 139 of file vtkCollection.h.

Member Data Documentation

Definition at line 133 of file vtkCollection.h.

Definition at line 134 of file vtkCollection.h.

Definition at line 135 of file vtkCollection.h.

Definition at line 136 of file vtkCollection.h.

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

Generated on Mon Sep 27 18:20:05 2010 for VTK by  doxygen 1.5.6