vtkInformationIterator Class Reference

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

#include <vtkInformationIterator.h>

Inheritance diagram for vtkInformationIterator:

Collaboration diagram for vtkInformationIterator:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()
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)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
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 vtkInformationIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkInformationIterator *	SafeDownCast (vtkObjectBase *o)
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
	vtkInformationIterator ()
	~vtkInformationIterator ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkInformation *	Information
vtkInformationIteratorInternals *	Internal
bool	ReferenceIsWeak
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

Tests:

vtkInformationIterator (Tests)

Definition at line 39 of file vtkInformationIterator.h.

Member Typedef Documentation

typedef vtkObject vtkInformationIterator::Superclass

Definition at line 43 of file vtkInformationIterator.h.

Constructor & Destructor Documentation

vtkInformationIterator::vtkInformationIterator ( )

protected

vtkInformationIterator::~vtkInformationIterator ( )

protected

Member Function Documentation

static vtkInformationIterator* vtkInformationIterator::New ( )

static

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

static

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

virtual vtkObjectBase* vtkInformationIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkInformationIterator* vtkInformationIterator::NewInstance

(

)

const

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 58 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 78 of file vtkInformationIterator.h.

vtkInformationIteratorInternals* vtkInformationIterator::Internal

protected

Definition at line 79 of file vtkInformationIterator.h.

bool vtkInformationIterator::ReferenceIsWeak

protected

Definition at line 81 of file vtkInformationIterator.h.

---

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

• dox/Common/Core/vtkInformationIterator.h