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

Store zero or more vtkInformation instances. More...

#include <vtkInformationVector.h>

Inheritance diagram for vtkInformationVector:
[legend]
Collaboration diagram for vtkInformationVector:
[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...
 
vtkInformationVectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Copy (vtkInformationVector *from, int deep=0)
 Copy all information entries from the given vtkInformation instance. More...
 
int GetNumberOfInformationObjects ()
 Get/Set the number of information objects in the vector. More...
 
void SetNumberOfInformationObjects (int n)
 Get/Set the number of information objects in the vector. More...
 
void SetInformationObject (int index, vtkInformation *info)
 Get/Set the vtkInformation instance stored at the given index in the vector. More...
 
vtkInformationGetInformationObject (int index)
 Get/Set the vtkInformation instance stored at the given index in the vector. More...
 
void Append (vtkInformation *info)
 Append/Remove an information object. More...
 
void Remove (vtkInformation *info)
 Append/Remove an information object. More...
 
void Remove (int idx)
 Append/Remove an information object. More...
 
void Register (vtkObjectBase *o) override
 Initiate garbage collection when a reference is removed. More...
 
void UnRegister (vtkObjectBase *o) override
 Initiate garbage collection when a reference is removed. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkInformationVectorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInformationVectorSafeDownCast (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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInformationVector ()
 
 ~vtkInformationVector () override
 
void ReportReferences (vtkGarbageCollector *) 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkInformationVectorInternals * Internal
 
int NumberOfInformationObjects
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Store zero or more vtkInformation instances.

vtkInformationVector stores a vector of zero or more vtkInformation objects corresponding to the input or output information for a vtkAlgorithm. An instance of this class is passed to vtkAlgorithm::ProcessRequest calls.

Definition at line 35 of file vtkInformationVector.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkInformationVector.h.

Constructor & Destructor Documentation

◆ vtkInformationVector()

vtkInformationVector::vtkInformationVector ( )
protected

◆ ~vtkInformationVector()

vtkInformationVector::~vtkInformationVector ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkInformationVector* vtkInformationVector::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkInformationVector::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 vtkInformationVector* vtkInformationVector::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInformationVector::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkInformationVector* vtkInformationVector::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetNumberOfInformationObjects()

int vtkInformationVector::GetNumberOfInformationObjects ( )
inline

Get/Set the number of information objects in the vector.

Setting the number to larger than the current number will create empty vtkInformation instances. Setting the number to smaller than the current number will remove entries from higher indices.

Definition at line 49 of file vtkInformationVector.h.

◆ SetNumberOfInformationObjects()

void vtkInformationVector::SetNumberOfInformationObjects ( int  n)

Get/Set the number of information objects in the vector.

Setting the number to larger than the current number will create empty vtkInformation instances. Setting the number to smaller than the current number will remove entries from higher indices.

◆ SetInformationObject()

void vtkInformationVector::SetInformationObject ( int  index,
vtkInformation info 
)

Get/Set the vtkInformation instance stored at the given index in the vector.

The vector will automatically expand to include the index given if necessary. Missing entries in-between will be filled with empty vtkInformation instances.

◆ GetInformationObject()

vtkInformation* vtkInformationVector::GetInformationObject ( int  index)

Get/Set the vtkInformation instance stored at the given index in the vector.

The vector will automatically expand to include the index given if necessary. Missing entries in-between will be filled with empty vtkInformation instances.

◆ Append()

void vtkInformationVector::Append ( vtkInformation info)

Append/Remove an information object.

◆ Remove() [1/2]

void vtkInformationVector::Remove ( vtkInformation info)

Append/Remove an information object.

◆ Remove() [2/2]

void vtkInformationVector::Remove ( int  idx)

Append/Remove an information object.

◆ Register()

void vtkInformationVector::Register ( vtkObjectBase o)
overridevirtual

Initiate garbage collection when a reference is removed.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkInformationVector::UnRegister ( vtkObjectBase o)
overridevirtual

Initiate garbage collection when a reference is removed.

Reimplemented from vtkObjectBase.

◆ Copy()

void vtkInformationVector::Copy ( vtkInformationVector from,
int  deep = 0 
)

Copy all information entries from the given vtkInformation instance.

Any previously existing entries are removed. If deep==1, a deep copy of the information structure is performed (new instances of any contained vtkInformation and vtkInformationVector objects are created).

◆ ReportReferences()

void vtkInformationVector::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ Internal

vtkInformationVectorInternals* vtkInformationVector::Internal
protected

Definition at line 95 of file vtkInformationVector.h.

◆ NumberOfInformationObjects

int vtkInformationVector::NumberOfInformationObjects
protected

Definition at line 97 of file vtkInformationVector.h.


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