vtkInformationVector Class Reference

Store zero or more vtkInformation instances. More...

#include <vtkInformationVector.h>

Inheritance diagram for vtkInformationVector:

Collaboration diagram for vtkInformationVector:

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.
vtkInformationVector *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Copy (vtkInformationVector *from, int deep=0)
	Copy all information entries from the given vtkInformation instance.
int	GetNumberOfInformationObjects ()
	Get/Set the number of information objects in the vector.
void	SetNumberOfInformationObjects (int n)
	Get/Set the number of information objects in the vector.
void	SetInformationObject (int index, vtkInformation *info)
	Get/Set the vtkInformation instance stored at the given index in the vector.
vtkInformation *	GetInformationObject (int index)
	Get/Set the vtkInformation instance stored at the given index in the vector.
void	Append (vtkInformation *info)
	Append/Remove an information object.
void	Remove (vtkInformation *info)
	Append/Remove an information object.
void	Remove (int idx)
	Append/Remove an information object.
void	Register (vtkObjectBase *o) override
	Initiate garbage collection when a reference is removed.
void	UnRegister (vtkObjectBase *o) override
	Initiate garbage collection when a reference is removed.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkInformationVector *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInformationVector *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	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.

Online Examples:

vtkImageAlgorithmFilter

vtkTestAlgorithmFilter

vtkTestFilterProgressFilter

vtkTestGraphAlgorithmFilter

vtkTestGraphAlgorithmSource

vtkTestMultipleInputPortsFilter

vtkTestPolyDataFilter

vtkTestProgressReportFilter

vtkTestReader

vtkTestFilter

Definition at line 144 of file vtkInformationVector.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkInformationVector::Superclass

Definition at line 148 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 158 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 204 of file vtkInformationVector.h.

NumberOfInformationObjects

int vtkInformationVector::NumberOfInformationObjects

protected

Definition at line 206 of file vtkInformationVector.h.

---

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

• Common/Core/vtkInformationVector.h