vtkInformationIterator Class Reference

#include <vtkInformationIterator.h>

Inheritance diagram for vtkInformationIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkInformationIterator:

Collaboration graph
[legend]

List of all members.


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 35 of file vtkInformationIterator.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 InitTraversal ()
virtual void GoToFirstItem ()
virtual void GoToNextItem ()
virtual int IsDoneWithTraversal ()
virtual vtkInformationKeyGetCurrentKey ()
void SetInformation (vtkInformation *)
virtual vtkInformationGetInformation ()

Static Public Member Functions

static vtkInformationIteratorNew ()
static int IsTypeOf (const char *type)
static vtkInformationIteratorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkInformationIterator ()
 ~vtkInformationIterator ()

Protected Attributes

vtkInformationInformation
vtkInformationIteratorInternals * Internal

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 39 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.

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

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 ( vtkObject o  )  [static]

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::InitTraversal (  )  [inline]

Move the iterator to the beginning of the collection.

Definition at line 49 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 1.


Member Data Documentation

Definition at line 69 of file vtkInformationIterator.h.

vtkInformationIteratorInternals* vtkInformationIterator::Internal [protected]

Definition at line 70 of file vtkInformationIterator.h.


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

Generated on Mon Sep 27 18:30:36 2010 for VTK by  doxygen 1.5.6