vtkInformationIterator Class Reference

Iterates over keys of an information object. More...

#include <vtkInformationIterator.h>

Inheritance diagram for vtkInformationIterator:

Collaboration diagram for vtkInformationIterator:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetInformationWeak (vtkInformation *)
void	InitTraversal ()
virtual void	GoToFirstItem ()
virtual void	GoToNextItem ()
virtual int	IsDoneWithTraversal ()
virtual vtkInformationKey *	GetCurrentKey ()
void	SetInformation (vtkInformation *)
virtual vtkInformation *	GetInformation ()
Static Public Member Functions
static vtkInformationIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkInformationIterator *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInformationIterator ()
	~vtkInformationIterator ()
Protected Attributes
vtkInformation *	Information
vtkInformationIteratorInternals *	Internal
bool	ReferenceIsWeak

---

Detailed Description

Iterates over keys of an information object.

vtkInformationIterator can be used to iterate over the keys of an information object. The corresponding values can then be directly obtained from the information object using the keys.

See also:

vtkInformation vtkInformationKey

Definition at line 36 of file vtkInformationIterator.h.

---

Member Typedef Documentation

typedef vtkObject vtkInformationIterator::Superclass

Reimplemented from vtkObject.

Definition at line 40 of file vtkInformationIterator.h.

---

Constructor & Destructor Documentation

vtkInformationIterator::vtkInformationIterator

(

)

[protected]

vtkInformationIterator::~vtkInformationIterator

(

)

[protected]

---

Member Function Documentation

static vtkInformationIterator* vtkInformationIterator::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkInformationIterator::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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 vtkObject.

virtual int vtkInformationIterator::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 vtkObject.

static vtkInformationIterator* vtkInformationIterator::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkInformationIterator::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkInformationIterator* vtkInformationIterator::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkInformationIterator::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.

void vtkInformationIterator::SetInformation

(

vtkInformation *

)

Set/Get the information to iterator over.

virtual vtkInformation* vtkInformationIterator::GetInformation

(

)

[virtual]

Set/Get the information to iterator over.

void vtkInformationIterator::SetInformationWeak

(

vtkInformation *

)

Set the function to iterate over. The iterator will not hold a reference to the information object. Can be used to optimize certain places by avoiding garbage collection.

void vtkInformationIterator::InitTraversal

(

)

[inline]

Move the iterator to the beginning of the collection.

Definition at line 55 of file vtkInformationIterator.h.

virtual void vtkInformationIterator::GoToFirstItem

(

)

[virtual]

Move the iterator to the beginning of the collection.

virtual void vtkInformationIterator::GoToNextItem

(

)

[virtual]

Move the iterator to the next item in the collection.

virtual int vtkInformationIterator::IsDoneWithTraversal

(

)

[virtual]

Test whether the iterator is currently pointing to a valid item. Returns 1 for yes, 0 for no.

virtual vtkInformationKey* vtkInformationIterator::GetCurrentKey

(

)

[virtual]

Get the current item. Valid only when IsDoneWithTraversal() returns

---

Member Data Documentation

vtkInformation* vtkInformationIterator::Information [protected]

Definition at line 75 of file vtkInformationIterator.h.

vtkInformationIteratorInternals* vtkInformationIterator::Internal [protected]

Definition at line 76 of file vtkInformationIterator.h.

bool vtkInformationIterator::ReferenceIsWeak [protected]

Definition at line 78 of file vtkInformationIterator.h.

---

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

• dox/Common/Core/vtkInformationIterator.h