Superclass for vtkInformation keys. More...

#include <vtkInformationKey.h>

Inheritance diagram for vtkInformationKey:

Collaboration diagram for vtkInformationKey:

Public Types
typedef vtkObjectBase	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *)
virtual void	UnRegister (vtkObjectBase *)
const char *	GetName ()
const char *	GetLocation ()
virtual void	ShallowCopy (vtkInformation from, vtkInformation to)=0
virtual int	Has (vtkInformation *info)
virtual void	Remove (vtkInformation *info)
virtual void	Report (vtkInformation info, vtkGarbageCollector collector)

	vtkInformationKey (const char name, const char location)
	~vtkInformationKey ()

virtual void	DeepCopy (vtkInformation from, vtkInformation to)

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

virtual bool	NeedToExecute (vtkInformation vtkNotUsed(pipelineInfo), vtkInformation vtkNotUsed(dobjInfo))

virtual void	StoreMetaData (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo))

virtual void	CopyDefaultInformation (vtkInformation vtkNotUsed(request), vtkInformation vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo))
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationKey *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	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 Attributes
char *	Name
char *	Location

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 37 of file vtkInformationKey.h.

Member Typedef Documentation

typedef vtkObjectBase vtkInformationKey::Superclass

Constructor & Destructor Documentation

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

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

static int vtkInformationKey::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkInformationKey::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.

static vtkInformationKey* vtkInformationKey::SafeDownCast ( vtkObjectBase * o ) [static]

virtual vtkObjectBase* vtkInformationKey::NewInstanceInternal ( ) const [protected, virtual]

vtkInformationKey* vtkInformationKey::NewInstance ( ) const

void vtkInformationKey::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

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.

virtual void vtkInformationKey::Register ( vtkObjectBase * ) [virtual]

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

virtual void vtkInformationKey::UnRegister ( vtkObjectBase * ) [virtual]

Prevent normal vtkObject reference counting behavior.

Reimplemented from vtkObjectBase.

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.

const char* vtkInformationKey::GetLocation ( )

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

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 vtkInformationObjectBaseVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationVariantVectorKey, vtkInformationDoubleVectorKey, vtkInformationExecutivePortVectorKey, vtkInformationIntegerVectorKey, vtkInformationStringVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationVariantKey, vtkInformationExecutivePortKey, vtkInformationDataObjectKey, vtkInformationDoubleKey, vtkInformationIntegerKey, vtkInformationStringKey, vtkInformationRequestKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationUnsignedLongKey, vtkInformationIntegerPointerKey, and vtkInformationInformationVectorKey.

virtual void vtkInformationKey::DeepCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)		`[inline, virtual]`

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 vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationInformationKey, and vtkInformationInformationVectorKey.

Definition at line 77 of file vtkInformationKey.h.

virtual int vtkInformationKey::Has ( vtkInformation * info ) [virtual]

Check whether this key appears in the given information object.

Reimplemented in vtkInformationRequestKey.

virtual void vtkInformationKey::Remove ( vtkInformation * info ) [virtual]

Remove this key from the given information object.

Reimplemented in vtkInformationExecutivePortVectorKey, and vtkInformationRequestKey.

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

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

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

void vtkInformationKey::Print ( vtkInformation * info )

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

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

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

virtual bool vtkInformationKey::NeedToExecute	(	vtkInformation *	vtkNotUsedpipelineInfo,
		vtkInformation *	vtkNotUseddobjInfo
	)		`[inline, virtual]`

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 103 of file vtkInformationKey.h.

virtual void vtkInformationKey::StoreMetaData	(	vtkInformation *	vtkNotUsedrequest,
		vtkInformation *	vtkNotUsedpipelineInfo,
		vtkInformation *	vtkNotUseddobjInfo
	)		`[inline, virtual]`

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 118 of file vtkInformationKey.h.

virtual void vtkInformationKey::CopyDefaultInformation	(	vtkInformation *	vtkNotUsedrequest,
		vtkInformation *	vtkNotUsedfromInfo,
		vtkInformation *	vtkNotUsedtoInfo
	)		`[inline, virtual]`

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 130 of file vtkInformationKey.h.

vtkInformationKey::vtkInformationKeySetStringMacro ( Name ) [protected]

vtkInformationKey::vtkInformationKeySetStringMacro ( Location ) [protected]

void vtkInformationKey::SetAsObjectBase	(	vtkInformation *	info,
		vtkObjectBase *	value
	)		`[protected]`

const vtkObjectBase* vtkInformationKey::GetAsObjectBase ( vtkInformation * info ) const [protected]

vtkObjectBase* vtkInformationKey::GetAsObjectBase ( vtkInformation * info ) [protected]

void vtkInformationKey::ReportAsObjectBase	(	vtkInformation *	info,
		vtkGarbageCollector *	collector
	)		`[protected]`

void vtkInformationKey::ConstructClass ( const char * ) [protected]

Member Data Documentation

char* vtkInformationKey::Name [protected]

Definition at line 136 of file vtkInformationKey.h.

char* vtkInformationKey::Location [protected]

Definition at line 137 of file vtkInformationKey.h.

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

/Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Common/Core/vtkInformationKey.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation