Store vtkAlgorithm input/output information. More...

#include <vtkInformation.h>

Inheritance diagram for vtkInformation:

Collaboration diagram for vtkInformation:

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.

vtkInformation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	PrintKeys (ostream &os, vtkIndent indent)

void	Modified () override
	Modified signature with no arguments that calls Modified on vtkObject superclass.

void	Modified (vtkInformationKey *key)
	Modified signature that takes an information key as an argument.

void	Clear ()
	Clear all information entries.

int	GetNumberOfKeys ()
	Return the number of keys in this information object (as would be returned by iterating over the keys).

void	Copy (vtkInformation *from, vtkTypeBool deep=0)
	Copy all information entries from the given vtkInformation instance.

void	Append (vtkInformation *from, vtkTypeBool deep=0)
	Append all information entries from the given vtkInformation instance.

void	CopyEntries (vtkInformation from, vtkInformationKeyVectorKey key, vtkTypeBool deep=0)
	Use the given key to lookup a list of other keys in the given information object.

int	Has (vtkInformationKey *key)
	Check whether the given key appears in this information object.

void	Remove (vtkInformationKey *key)
	Remove the given key and its data from this information object.

void	Append (vtkInformationKeyVectorKey key, vtkInformationDataObjectKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationDoubleKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationDoubleVectorKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationInformationKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationInformationVectorKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationIntegerKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationIntegerVectorKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationStringKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationStringVectorKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationObjectBaseKey value)

void	Append (vtkInformationKeyVectorKey key, vtkInformationUnsignedLongKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationDataObjectKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationDoubleKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationDoubleVectorKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationInformationKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationInformationVectorKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationIntegerKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationIntegerVectorKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationStringKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationStringVectorKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationObjectBaseKey value)

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationUnsignedLongKey value)


void	CopyEntry (vtkInformation from, vtkInformationKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationDataObjectKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationDoubleVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationVariantKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationVariantVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationInformationKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationInformationVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationIntegerKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationIntegerVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationObjectBaseVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationRequestKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationStringKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationStringVectorKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.

void	CopyEntry (vtkInformation from, vtkInformationUnsignedLongKey key, vtkTypeBool deep=0)
	Copy the key/value pair associated with the given key in the given information object.


void	Set (vtkInformationRequestKey *key)
	Get/Set a request-valued entry.

void	Remove (vtkInformationRequestKey *key)
	Get/Set a request-valued entry.

int	Has (vtkInformationRequestKey *key)
	Get/Set a request-valued entry.


void	Set (vtkInformationIntegerKey *key, int value)
	Get/Set an integer-valued entry.

int	Get (vtkInformationIntegerKey *key)
	Get/Set an integer-valued entry.

void	Remove (vtkInformationIntegerKey *key)
	Get/Set an integer-valued entry.

int	Has (vtkInformationIntegerKey *key)
	Get/Set an integer-valued entry.


void	Set (vtkInformationIdTypeKey *key, vtkIdType value)
	Get/Set a vtkIdType-valued entry.

vtkIdType	Get (vtkInformationIdTypeKey *key)
	Get/Set a vtkIdType-valued entry.

void	Remove (vtkInformationIdTypeKey *key)
	Get/Set a vtkIdType-valued entry.

int	Has (vtkInformationIdTypeKey *key)
	Get/Set a vtkIdType-valued entry.


void	Set (vtkInformationDoubleKey *key, double value)
	Get/Set an double-valued entry.

double	Get (vtkInformationDoubleKey *key)
	Get/Set an double-valued entry.

void	Remove (vtkInformationDoubleKey *key)
	Get/Set an double-valued entry.

int	Has (vtkInformationDoubleKey *key)
	Get/Set an double-valued entry.


void	Set (vtkInformationVariantKey *key, const vtkVariant &value)
	Get/Set an variant-valued entry.

const vtkVariant &	Get (vtkInformationVariantKey *key)
	Get/Set an variant-valued entry.

void	Remove (vtkInformationVariantKey *key)
	Get/Set an variant-valued entry.

int	Has (vtkInformationVariantKey *key)
	Get/Set an variant-valued entry.


void	Append (vtkInformationIntegerVectorKey *key, int value)
	Get/Set an integer-vector-valued entry.

void	Set (vtkInformationIntegerVectorKey key, const int value, int length)
	Get/Set an integer-vector-valued entry.

void	Set (vtkInformationIntegerVectorKey *key, int value1, int value2, int value3)
	Get/Set an integer-vector-valued entry.

void	Set (vtkInformationIntegerVectorKey *key, int value1, int value2, int value3, int value4, int value5, int value6)
	Get/Set an integer-vector-valued entry.

int *	Get (vtkInformationIntegerVectorKey *key)
	Get/Set an integer-vector-valued entry.

int	Get (vtkInformationIntegerVectorKey *key, int idx)
	Get/Set an integer-vector-valued entry.

void	Get (vtkInformationIntegerVectorKey key, int value)
	Get/Set an integer-vector-valued entry.

int	Length (vtkInformationIntegerVectorKey *key)
	Get/Set an integer-vector-valued entry.

void	Remove (vtkInformationIntegerVectorKey *key)
	Get/Set an integer-vector-valued entry.

int	Has (vtkInformationIntegerVectorKey *key)
	Get/Set an integer-vector-valued entry.


void	Append (vtkInformationStringVectorKey key, const char value)
	Get/Set a string-vector-valued entry.

void	Set (vtkInformationStringVectorKey key, const char value, int idx=0)
	Get/Set a string-vector-valued entry.

void	Append (vtkInformationStringVectorKey *key, const std::string &value)
	Get/Set a string-vector-valued entry.

void	Set (vtkInformationStringVectorKey *key, const std::string &value, int idx=0)
	Get/Set a string-vector-valued entry.

const char *	Get (vtkInformationStringVectorKey *key, int idx=0)
	Get/Set a string-vector-valued entry.

int	Length (vtkInformationStringVectorKey *key)
	Get/Set a string-vector-valued entry.

void	Remove (vtkInformationStringVectorKey *key)
	Get/Set a string-vector-valued entry.

int	Has (vtkInformationStringVectorKey *key)
	Get/Set a string-vector-valued entry.


void	Set (vtkInformationIntegerPointerKey key, int value, int length)
	Get/Set an integer-pointer-valued entry.

int *	Get (vtkInformationIntegerPointerKey *key)
	Get/Set an integer-pointer-valued entry.

void	Get (vtkInformationIntegerPointerKey key, int value)
	Get/Set an integer-pointer-valued entry.

int	Length (vtkInformationIntegerPointerKey *key)
	Get/Set an integer-pointer-valued entry.

void	Remove (vtkInformationIntegerPointerKey *key)
	Get/Set an integer-pointer-valued entry.

int	Has (vtkInformationIntegerPointerKey *key)
	Get/Set an integer-pointer-valued entry.


void	Set (vtkInformationUnsignedLongKey *key, unsigned long value)
	Get/Set an unsigned-long-valued entry.

unsigned long	Get (vtkInformationUnsignedLongKey *key)
	Get/Set an unsigned-long-valued entry.

void	Remove (vtkInformationUnsignedLongKey *key)
	Get/Set an unsigned-long-valued entry.

int	Has (vtkInformationUnsignedLongKey *key)
	Get/Set an unsigned-long-valued entry.


void	Append (vtkInformationDoubleVectorKey *key, double value)
	Get/Set an double-vector-valued entry.

void	Set (vtkInformationDoubleVectorKey key, const double value, int length)
	Get/Set an double-vector-valued entry.

void	Set (vtkInformationDoubleVectorKey *key, double value1, double value2, double value3)
	Get/Set an double-vector-valued entry.

void	Set (vtkInformationDoubleVectorKey *key, double value1, double value2, double value3, double value4, double value5, double value6)
	Get/Set an double-vector-valued entry.

double *	Get (vtkInformationDoubleVectorKey *key)
	Get/Set an double-vector-valued entry.

double	Get (vtkInformationDoubleVectorKey *key, int idx)
	Get/Set an double-vector-valued entry.

void	Get (vtkInformationDoubleVectorKey key, double value)
	Get/Set an double-vector-valued entry.

int	Length (vtkInformationDoubleVectorKey *key)
	Get/Set an double-vector-valued entry.

void	Remove (vtkInformationDoubleVectorKey *key)
	Get/Set an double-vector-valued entry.

int	Has (vtkInformationDoubleVectorKey *key)
	Get/Set an double-vector-valued entry.


void	Append (vtkInformationVariantVectorKey *key, const vtkVariant &value)
	Get/Set an variant-vector-valued entry.

void	Set (vtkInformationVariantVectorKey key, const vtkVariant value, int length)
	Get/Set an variant-vector-valued entry.

void	Set (vtkInformationVariantVectorKey *key, const vtkVariant &value1, const vtkVariant &value2, const vtkVariant &value3)
	Get/Set an variant-vector-valued entry.

void	Set (vtkInformationVariantVectorKey *key, const vtkVariant &value1, const vtkVariant &value2, const vtkVariant &value3, const vtkVariant &value4, const vtkVariant &value5, const vtkVariant &value6)
	Get/Set an variant-vector-valued entry.

const vtkVariant *	Get (vtkInformationVariantVectorKey *key)
	Get/Set an variant-vector-valued entry.

const vtkVariant &	Get (vtkInformationVariantVectorKey *key, int idx)
	Get/Set an variant-vector-valued entry.

void	Get (vtkInformationVariantVectorKey key, vtkVariant value)
	Get/Set an variant-vector-valued entry.

int	Length (vtkInformationVariantVectorKey *key)
	Get/Set an variant-vector-valued entry.

void	Remove (vtkInformationVariantVectorKey *key)
	Get/Set an variant-vector-valued entry.

int	Has (vtkInformationVariantVectorKey *key)
	Get/Set an variant-vector-valued entry.


void	Append (vtkInformationKeyVectorKey key, vtkInformationKey value)
	Get/Set an InformationKey-vector-valued entry.

void	AppendUnique (vtkInformationKeyVectorKey key, vtkInformationKey value)
	Get/Set an InformationKey-vector-valued entry.

void	Set (vtkInformationKeyVectorKey key, vtkInformationKey const *value, int length)
	Get/Set an InformationKey-vector-valued entry.

void	Remove (vtkInformationKeyVectorKey key, vtkInformationKey value)
	Get/Set an InformationKey-vector-valued entry.

vtkInformationKey **	Get (vtkInformationKeyVectorKey *key)
	Get/Set an InformationKey-vector-valued entry.

vtkInformationKey *	Get (vtkInformationKeyVectorKey *key, int idx)
	Get/Set an InformationKey-vector-valued entry.

void	Get (vtkInformationKeyVectorKey key, vtkInformationKey *value)
	Get/Set an InformationKey-vector-valued entry.

int	Length (vtkInformationKeyVectorKey *key)
	Get/Set an InformationKey-vector-valued entry.

void	Remove (vtkInformationKeyVectorKey *key)
	Get/Set an InformationKey-vector-valued entry.

int	Has (vtkInformationKeyVectorKey *key)
	Get/Set an InformationKey-vector-valued entry.


void	Set (vtkInformationStringKey key, const char )
	Get/Set a string-valued entry.

void	Set (vtkInformationStringKey *key, const std::string &)
	Get/Set a string-valued entry.

const char *	Get (vtkInformationStringKey *key)
	Get/Set a string-valued entry.

void	Remove (vtkInformationStringKey *key)
	Get/Set a string-valued entry.

int	Has (vtkInformationStringKey *key)
	Get/Set a string-valued entry.


void	Set (vtkInformationInformationKey key, vtkInformation )
	Get/Set an entry storing another vtkInformation instance.

vtkInformation *	Get (vtkInformationInformationKey *key)
	Get/Set an entry storing another vtkInformation instance.

void	Remove (vtkInformationInformationKey *key)
	Get/Set an entry storing another vtkInformation instance.

int	Has (vtkInformationInformationKey *key)
	Get/Set an entry storing another vtkInformation instance.


void	Set (vtkInformationInformationVectorKey key, vtkInformationVector )
	Get/Set an entry storing a vtkInformationVector instance.

vtkInformationVector *	Get (vtkInformationInformationVectorKey *key)
	Get/Set an entry storing a vtkInformationVector instance.

void	Remove (vtkInformationInformationVectorKey *key)
	Get/Set an entry storing a vtkInformationVector instance.

int	Has (vtkInformationInformationVectorKey *key)
	Get/Set an entry storing a vtkInformationVector instance.


void	Set (vtkInformationObjectBaseKey key, vtkObjectBase )
	Get/Set an entry storing a vtkObjectBase instance.

vtkObjectBase *	Get (vtkInformationObjectBaseKey *key)
	Get/Set an entry storing a vtkObjectBase instance.

void	Remove (vtkInformationObjectBaseKey *key)
	Get/Set an entry storing a vtkObjectBase instance.

int	Has (vtkInformationObjectBaseKey *key)
	Get/Set an entry storing a vtkObjectBase instance.


void	Append (vtkInformationObjectBaseVectorKey key, vtkObjectBase data)
	Manipulate a ObjectBaseVector entry.

void	Set (vtkInformationObjectBaseVectorKey key, vtkObjectBase value, int idx=0)
	Manipulate a ObjectBaseVector entry.

vtkObjectBase *	Get (vtkInformationObjectBaseVectorKey *key, int idx=0)
	Manipulate a ObjectBaseVector entry.

int	Length (vtkInformationObjectBaseVectorKey *key)
	Manipulate a ObjectBaseVector entry.

void	Remove (vtkInformationObjectBaseVectorKey *key)
	Manipulate a ObjectBaseVector entry.

void	Remove (vtkInformationObjectBaseVectorKey key, vtkObjectBase objectToRemove)
	Manipulate a ObjectBaseVector entry.

void	Remove (vtkInformationObjectBaseVectorKey *key, int indexToRemove)
	Manipulate a ObjectBaseVector entry.

int	Has (vtkInformationObjectBaseVectorKey *key)
	Manipulate a ObjectBaseVector entry.


void	Set (vtkInformationDataObjectKey key, vtkDataObject VTK_WRAP_EXTERN )
	Get/Set an entry storing a vtkDataObject instance.

vtkDataObject VTK_WRAP_EXTERN *	Get (vtkInformationDataObjectKey *key)
	Get/Set an entry storing a vtkDataObject instance.

void	Remove (vtkInformationDataObjectKey *key)
	Get/Set an entry storing a vtkDataObject instance.

int	Has (vtkInformationDataObjectKey *key)
	Get/Set an entry storing a vtkDataObject instance.


bool	UsesGarbageCollector () const override
	Initiate garbage collection when a reference is removed.


void	SetRequest (vtkInformationRequestKey *request)
	Get/Set the Request ivar.

vtkInformationRequestKey *	GetRequest ()
	Get/Set the Request ivar.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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 vtkInformation *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInformation *	SafeDownCast (vtkObjectBase *o)


static vtkInformationKey *	GetKey (vtkInformationDataObjectKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationDoubleKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationDoubleVectorKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationInformationKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationInformationVectorKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationIntegerKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationIntegerVectorKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationRequestKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationStringKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationStringVectorKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationUnsignedLongKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationVariantKey *key)
	Upcast the given key instance.

static vtkInformationKey *	GetKey (vtkInformationVariantVectorKey *key)
	Upcast the given key instance.

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 (vtkTypeBool 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 vtkTypeBool	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

	vtkInformation ()

	~vtkInformation () override

void	SetAsObjectBase (vtkInformationKey key, vtkObjectBase value)

const vtkObjectBase *	GetAsObjectBase (const vtkInformationKey *key) const

vtkObjectBase *	GetAsObjectBase (vtkInformationKey *key)

void	ReportReferences (vtkGarbageCollector *) override

void	ReportAsObjectBase (vtkInformationKey key, vtkGarbageCollector collector)

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 *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkInformationInternals *	Internal

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkInformationKeyToInformationFriendship

class	vtkInformationIterator

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 vtkAlgorithm input/output information.

vtkInformation represents information and/or data for one input or one output of a vtkAlgorithm. It maps from keys to values of several data types. Instances of this class are collected in vtkInformationVector instances and passed to vtkAlgorithm::ProcessRequest calls. The information and data referenced by the instance on a particular input or output define the request made to the vtkAlgorithm instance.

Events:: vtkCommand::ModifiedEvent

Examples:: vtkInformation (Examples)

Online Examples:

vtkTestAlgorithmFilter

vtkTestAlgorithmSource

vtkTestGraphAlgorithmFilter

vtkTestGraphAlgorithmSource

vtkTestPolyDataFilter

ImageClip

FillHoles

ExtractSelection

ExtractSelectionUsingPoints

MergeSelections

Tests:: vtkInformation (Tests)

Definition at line 171 of file vtkInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkInformation::Superclass

Definition at line 175 of file vtkInformation.h.

Constructor & Destructor Documentation

◆ vtkInformation()

vtkInformation::vtkInformation ( )

protected

◆ ~vtkInformation()

vtkInformation::~vtkInformation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkInformation * vtkInformation::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInformation::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkInformation * vtkInformation::NewInstance ( ) const

◆ PrintSelf()

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

◆ PrintKeys()

void vtkInformation::PrintKeys	(	ostream &	os,
		vtkIndent	indent
	)

◆ Modified() [1/2]

void vtkInformation::Modified ( )

overridevirtual

Modified signature with no arguments that calls Modified on vtkObject superclass.

Reimplemented from vtkObject.

◆ Modified() [2/2]

void vtkInformation::Modified ( vtkInformationKey * key )

Modified signature that takes an information key as an argument.

Sets the new MTime and invokes a modified event with the information key as call data.

◆ Clear()

void vtkInformation::Clear ( )

Clear all information entries.

◆ GetNumberOfKeys()

int vtkInformation::GetNumberOfKeys ( )

Return the number of keys in this information object (as would be returned by iterating over the keys).

◆ Copy()

void vtkInformation::Copy	(	vtkInformation *	from,
		vtkTypeBool	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).

◆ Append() [1/19]

void vtkInformation::Append	(	vtkInformation *	from,
		vtkTypeBool	deep = `0`
	)

Append all information entries from the given vtkInformation instance.

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