vtkDataObjectCollection Class Reference

maintain an unordered list of data objects More...

#include <vtkDataObjectCollection.h>

Inheritance diagram for vtkDataObjectCollection:

Collaboration diagram for vtkDataObjectCollection:

Public Types
typedef vtkCollection	Superclass
Public Types inherited from vtkCollection
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkDataObjectCollection *	NewInstance () const
void	AddItem (vtkDataObject *ds)
vtkDataObject *	GetNextItem ()
vtkDataObject *	GetItem (int i)
vtkDataObject *	GetNextDataObject (vtkCollectionSimpleIterator &cookie)
Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const
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 ()
vtkObject *	GetNextItemAsObject ()
vtkObject *	GetItemAsObject (int i)
vtkCollectionIterator *	NewIterator ()
void	InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkDataObjectCollection *	New ()
static int	IsTypeOf (const char *type)
static vtkDataObjectCollection *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCollection
static int	IsTypeOf (const char *type)
static vtkCollection *	SafeDownCast (vtkObjectBase *o)
static vtkCollection *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataObjectCollection ()
	~vtkDataObjectCollection ()
Protected Member Functions inherited from vtkCollection
virtual void	RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
virtual void	DeleteElement (vtkCollectionElement *)
virtual void	ReportReferences (vtkGarbageCollector *collector)
	vtkCollection ()
	~vtkCollection ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkCollection
int	NumberOfItems
vtkCollectionElement *	Top
vtkCollectionElement *	Bottom
vtkCollectionElement *	Current
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

maintain an unordered list of data objects

vtkDataObjectCollection is an object that creates and manipulates lists of data objects. See also vtkCollection and subclasses.

Examples:

vtkDataObjectCollection (Examples)

Definition at line 33 of file vtkDataObjectCollection.h.

Member Typedef Documentation

typedef vtkCollection vtkDataObjectCollection::Superclass

Definition at line 37 of file vtkDataObjectCollection.h.

Constructor & Destructor Documentation

vtkDataObjectCollection::vtkDataObjectCollection ( )

inlineprotected

Definition at line 75 of file vtkDataObjectCollection.h.

vtkDataObjectCollection::~vtkDataObjectCollection ( )

inlineprotected

Definition at line 76 of file vtkDataObjectCollection.h.

Member Function Documentation

static vtkDataObjectCollection* vtkDataObjectCollection::New ( )

static

static int vtkDataObjectCollection::IsTypeOf ( const char *  type )

static

virtual int vtkDataObjectCollection::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCollection.

static vtkDataObjectCollection* vtkDataObjectCollection::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkDataObjectCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCollection.

vtkDataObjectCollection* vtkDataObjectCollection::NewInstance

(

)

const

void vtkDataObjectCollection::AddItem ( vtkDataObject *  ds )

inline

Add a data object to the list.

Definition at line 41 of file vtkDataObjectCollection.h.

vtkDataObject* vtkDataObjectCollection::GetNextItem ( )

inline

Get the next data object in the list.

Definition at line 49 of file vtkDataObjectCollection.h.

vtkDataObject* vtkDataObjectCollection::GetItem ( int  i )

inline

Get the ith data object in the list.

Definition at line 57 of file vtkDataObjectCollection.h.

vtkDataObject* vtkDataObjectCollection::GetNextDataObject ( vtkCollectionSimpleIterator &  cookie )

inline

Reentrant safe way to get an object in a collection. Just pass the same cookie back and forth.

Definition at line 67 of file vtkDataObjectCollection.h.

---

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

• dox/Common/DataModel/vtkDataObjectCollection.h