VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInformationIterator Class Reference

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

#include <vtkInformationIterator.h>

Inheritance diagram for vtkInformationIterator:
[legend]
Collaboration diagram for vtkInformationIterator:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkInformationIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetInformation (vtkInformation *)
 Set/Get the information to iterator over. More...
 
virtual vtkInformationGetInformation ()
 
void SetInformationWeak (vtkInformation *)
 Set the function to iterate over. More...
 
void InitTraversal ()
 Move the iterator to the beginning of the collection. More...
 
virtual void GoToFirstItem ()
 Move the iterator to the beginning of the collection. More...
 
virtual void GoToNextItem ()
 Move the iterator to the next item in the collection. More...
 
virtual int IsDoneWithTraversal ()
 Test whether the iterator is currently pointing to a valid item. More...
 
virtual vtkInformationKeyGetCurrentKey ()
 Get the current item. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkInformationIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInformationIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInformationIterator ()
 
 ~vtkInformationIterator () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkInformationInformation
 
vtkInformationIteratorInternals * Internal
 
bool ReferenceIsWeak
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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

Definition at line 37 of file vtkInformationIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkInformationIterator.h.

Constructor & Destructor Documentation

◆ vtkInformationIterator()

vtkInformationIterator::vtkInformationIterator ( )
protected

◆ ~vtkInformationIterator()

vtkInformationIterator::~vtkInformationIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkInformationIterator* vtkInformationIterator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInformationIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkInformationIterator* vtkInformationIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkInformationIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObjectBase.

◆ SetInformation()

void vtkInformationIterator::SetInformation ( vtkInformation )

Set/Get the information to iterator over.

◆ GetInformation()

virtual vtkInformation* vtkInformationIterator::GetInformation ( )
virtual

◆ SetInformationWeak()

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.

◆ InitTraversal()

void vtkInformationIterator::InitTraversal ( )
inline

Move the iterator to the beginning of the collection.

Definition at line 63 of file vtkInformationIterator.h.

◆ GoToFirstItem()

virtual void vtkInformationIterator::GoToFirstItem ( )
virtual

Move the iterator to the beginning of the collection.

◆ GoToNextItem()

virtual void vtkInformationIterator::GoToNextItem ( )
virtual

Move the iterator to the next item in the collection.

◆ IsDoneWithTraversal()

virtual int vtkInformationIterator::IsDoneWithTraversal ( )
virtual

Test whether the iterator is currently pointing to a valid item.

Returns 1 for yes, 0 for no.

◆ GetCurrentKey()

virtual vtkInformationKey* vtkInformationIterator::GetCurrentKey ( )
virtual

Get the current item.

Valid only when IsDoneWithTraversal() returns 1.

Member Data Documentation

◆ Information

vtkInformation* vtkInformationIterator::Information
protected

Definition at line 91 of file vtkInformationIterator.h.

◆ Internal

vtkInformationIteratorInternals* vtkInformationIterator::Internal
protected

Definition at line 92 of file vtkInformationIterator.h.

◆ ReferenceIsWeak

bool vtkInformationIterator::ReferenceIsWeak
protected

Definition at line 94 of file vtkInformationIterator.h.


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