vtkInformationKey Class Reference

#include <vtkInformationKey.h>

Inheritance diagram for vtkInformationKey:

[legend]

Collaboration diagram for vtkInformationKey:

[legend]

List of all members.

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


Public Types
typedef vtkObjectBase	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationKey *	SafeDownCast (vtkObject *o)
Protected Member Functions
void	SetAsObjectBase (vtkInformation info, vtkObjectBase value)
vtkObjectBase *	GetAsObjectBase (vtkInformation *info)
void	ReportAsObjectBase (vtkInformation info, vtkGarbageCollector collector)
void	ConstructClass (const char *)
Protected Attributes
const char *	Name
const char *	Location

Member Typedef Documentation

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

virtual const char* vtkInformationKey::GetClassName ( ) [virtual]

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

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

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

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

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

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.

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

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

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

Definition at line 76 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 vtkInformationRequestKey, and vtkInformationExecutivePortVectorKey.