Superclass for vtkInformation keys. More...

#include <vtkInformationKey.h>

Inheritance diagram for vtkInformationKey:

Collaboration diagram for vtkInformationKey:

Public Member Functions
	vtkBaseTypeMacro (vtkInformationKey, vtkObjectBase)

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

void	Register (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior.

void	UnRegister (vtkObjectBase *) override
	Prevent normal vtkObject reference counting behavior.

const char *	GetName ()
	Get the name of the key.

const char *	GetLocation ()
	Get the location of the key.

virtual void	ShallowCopy (vtkInformation from, vtkInformation to)=0
	Copy the entry associated with this key from one information object to another.

virtual void	DeepCopy (vtkInformation from, vtkInformation to)
	Duplicate (new instance created) the entry associated with this key from one information object to another (new instances of any contained vtkInformation and vtkInformationVector objects are created).

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

virtual void	Remove (vtkInformation *info)
	Remove this key from the given information object.

virtual void	Report (vtkInformation info, vtkGarbageCollector collector)
	Report a reference this key has in the given information object.

virtual bool	NeedToExecute (vtkInformation vtkNotUsed(pipelineInfo), vtkInformation vtkNotUsed(dobjInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline.

virtual void	StoreMetaData (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline.

virtual void	CopyDefaultInformation (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))
	This function is only relevant when the pertaining key is used in a VTK pipeline.


	vtkInformationKey (const char name, const char location)
	Key instances are static data that need to be created and destroyed.

	~vtkInformationKey () override
	Key instances are static data that need to be created and destroyed.


void	Print (vtkInformation *info)
	Print the key's value in an information object to a stream.

virtual void	Print (ostream &os, vtkInformation *info)
	Print the key's value in an information object to a stream.

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.

Protected Member Functions
	vtkInformationKeySetStringMacro (Name)

	vtkInformationKeySetStringMacro (Location)

void	SetAsObjectBase (vtkInformation info, vtkObjectBase value)

const vtkObjectBase *	GetAsObjectBase (vtkInformation *info) const

vtkObjectBase *	GetAsObjectBase (vtkInformation *info)

void	ReportAsObjectBase (vtkInformation info, vtkGarbageCollector collector)

void	ConstructClass (const char *)

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
char *	Name

char *	Location

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

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Superclass for vtkInformation keys.

vtkInformationKey is the superclass for all keys used to access the map represented by vtkInformation. The vtkInformation::Set and vtkInformation::Get methods of vtkInformation are accessed by information keys. A key is a pointer to an instance of a subclass of vtkInformationKey. The type of the subclass determines the overload of Set/Get that is selected. This ensures that the type of value stored in a vtkInformation instance corresponding to a given key matches the type expected for that key.

Definition at line 38 of file vtkInformationKey.h.

Constructor & Destructor Documentation

◆ vtkInformationKey()

vtkInformationKey::vtkInformationKey	(	const char *	name,
		const char *	location
	)

Key instances are static data that need to be created and destroyed.

The constructor and destructor must be public. The name of the static instance and the class in which it is defined should be passed to the constructor. They must be string literals because the strings are not copied.

◆ ~vtkInformationKey()

vtkInformationKey::~vtkInformationKey ( )

override

Key instances are static data that need to be created and destroyed.

The constructor and destructor must be public. The name of the static instance and the class in which it is defined should be passed to the constructor. They must be string literals because the strings are not copied.

Member Function Documentation

◆ vtkBaseTypeMacro()

vtkInformationKey::vtkBaseTypeMacro	(	vtkInformationKey	,
		vtkObjectBase
	)

◆ PrintSelf()

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

Reimplemented in vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationObjectBaseVectorKey, vtkInformationRequestKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationUnsignedLongKey, vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDataObjectMetaDataKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, and vtkInformationIntegerRequestKey.

◆ Register()

void vtkInformationKey::Register ( vtkObjectBase * )

overridevirtual

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkInformationKey::UnRegister ( vtkObjectBase * )

overridevirtual

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

◆ GetName()

const char * vtkInformationKey::GetName ( )

Get the name of the key.

This is not the type of the key, but the name of the key instance.

◆ GetLocation()

const char * vtkInformationKey::GetLocation ( )

Get the location of the key.

This is the name of the class in which the key is defined.

◆ ShallowCopy()

virtual void vtkInformationKey::ShallowCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)

pure virtual

Copy the entry associated with this key from one information object to another.

If there is no entry in the first information object for this key, the value is removed from the second.

Implemented in vtkInformationDataObjectKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationRequestKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationUnsignedLongKey, vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, and vtkInformationObjectBaseVectorKey.

◆ DeepCopy()

virtual void vtkInformationKey::DeepCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)

inlinevirtual

Duplicate (new instance created) the entry associated with this key from one information object to another (new instances of any contained vtkInformation and vtkInformationVector objects are created).

Default implementation simply calls ShallowCopy().

Reimplemented in vtkInformationInformationKey, vtkInformationInformationVectorKey, and vtkInformationQuadratureSchemeDefinitionVectorKey.

Definition at line 91 of file vtkInformationKey.h.

◆ Has()

virtual int vtkInformationKey::Has ( vtkInformation * info )

virtual

Check whether this key appears in the given information object.

Reimplemented in vtkInformationRequestKey.

◆ Remove()

virtual void vtkInformationKey::Remove ( vtkInformation * info )

virtual

Remove this key from the given information object.

Reimplemented in vtkInformationObjectBaseVectorKey, vtkInformationRequestKey, and vtkInformationExecutivePortVectorKey.

◆ Report()

virtual void vtkInformationKey::Report	(	vtkInformation *	info,
		vtkGarbageCollector *	collector
	)

virtual

Report a reference this key has in the given information object.

Reimplemented in vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationExecutivePortKey, and vtkInformationExecutivePortVectorKey.

◆ Print() [1/2]

void vtkInformationKey::Print ( vtkInformation * info )

Print the key's value in an information object to a stream.

◆ Print() [2/2]

virtual void vtkInformationKey::Print	(	ostream &	os,
		vtkInformation *	info
	)

virtual

Print the key's value in an information object to a stream.

Reimplemented in vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationIdTypeKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationRequestKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationUnsignedLongKey, vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationExecutivePortKey, and vtkInformationExecutivePortVectorKey.

◆ NeedToExecute()

virtual bool vtkInformationKey::NeedToExecute	(	vtkInformation *	vtkNotUsedpipelineInfo,
		vtkInformation *	vtkNotUseddobjInfo
	)

inlinevirtual

This function is only relevant when the pertaining key is used in a VTK pipeline.

Specific keys that handle pipeline data requests (for example, UPDATE_PIECE_NUMBER) can overwrite this method to notify the pipeline that a a filter should be (re-)executed because what is in the current output is different that what is being requested by the key. For example, DATA_PIECE_NUMBER != UPDATE_PIECE_NUMBER.

Definition at line 125 of file vtkInformationKey.h.

◆ StoreMetaData()

virtual void vtkInformationKey::StoreMetaData	(	vtkInformation *	vtkNotUsedrequest,
		vtkInformation *	vtkNotUsedpipelineInfo,
		vtkInformation *	vtkNotUseddobjInfo
	)

inlinevirtual

This function is only relevant when the pertaining key is used in a VTK pipeline.

Specific keys that handle pipeline data requests (for example, UPDATE_PIECE_NUMBER) can overwrite this method to store in the data information meta-data about the request that led to the current filter execution. This meta-data can later be used to compare what is being requested to decide whether the filter needs to re-execute. For example, a filter may store the current UPDATE_PIECE_NUMBER in the data object's information as the DATA_PIECE_NUMBER. DATA_PIECE_NUMBER can later be compared to a new UPDATA_PIECE_NUMBER to decide whether a filter should re-execute.

Definition at line 145 of file vtkInformationKey.h.

◆ CopyDefaultInformation()

virtual void vtkInformationKey::CopyDefaultInformation	(	vtkInformation *	vtkNotUsedrequest,
		vtkInformation *	vtkNotUsedfromInfo,
		vtkInformation *	vtkNotUsedtoInfo
	)

inlinevirtual

This function is only relevant when the pertaining key is used in a VTK pipeline.

By overwriting this method, a key can decide if/how to copy itself downstream or upstream during a particular pipeline pass. For example, meta-data keys can copy themselves during REQUEST_INFORMATION whereas request keys can copy themselves during REQUEST_UPDATE_EXTENT.

Definition at line 158 of file vtkInformationKey.h.

◆ vtkInformationKeySetStringMacro() [1/2]

vtkInformationKey::vtkInformationKeySetStringMacro ( Name )

protected

◆ vtkInformationKeySetStringMacro() [2/2]

vtkInformationKey::vtkInformationKeySetStringMacro ( Location )

protected

◆ SetAsObjectBase()

void vtkInformationKey::SetAsObjectBase	(	vtkInformation *	info,
		vtkObjectBase *	value
	)

protected

◆ GetAsObjectBase() [1/2]

const vtkObjectBase * vtkInformationKey::GetAsObjectBase ( vtkInformation * info ) const

protected

◆ GetAsObjectBase() [2/2]

vtkObjectBase * vtkInformationKey::GetAsObjectBase ( vtkInformation * info )

protected

◆ ReportAsObjectBase()

void vtkInformationKey::ReportAsObjectBase	(	vtkInformation *	info,
		vtkGarbageCollector *	collector
	)

protected

◆ ConstructClass()

void vtkInformationKey::ConstructClass ( const char * )

protected

Member Data Documentation

◆ Name

char* vtkInformationKey::Name

protected

Definition at line 164 of file vtkInformationKey.h.

◆ Location

char* vtkInformationKey::Location

protected

Definition at line 165 of file vtkInformationKey.h.

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

Common/Core/vtkInformationKey.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ vtkInformationKey()

◆ ~vtkInformationKey()

Member Function Documentation

◆ vtkBaseTypeMacro()

◆ PrintSelf()

◆ Register()

◆ UnRegister()

◆ GetName()

◆ GetLocation()

◆ ShallowCopy()

◆ DeepCopy()

◆ Has()

◆ Remove()

◆ Report()

◆ Print() [1/2]

◆ Print() [2/2]

◆ NeedToExecute()

◆ StoreMetaData()

◆ CopyDefaultInformation()

◆ vtkInformationKeySetStringMacro() [1/2]

◆ vtkInformationKeySetStringMacro() [2/2]

◆ SetAsObjectBase()

◆ GetAsObjectBase() [1/2]

◆ GetAsObjectBase() [2/2]

◆ ReportAsObjectBase()

◆ ConstructClass()

Member Data Documentation

◆ Name

◆ Location