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.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (90%)
Martin, Ken (9%)

CVS logs (CVSweb):

.h (/Filtering/vtkInformationKey.h)
.cxx (/Filtering/vtkInformationKey.cxx)

Definition at line 47 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 Copy (vtkInformation *from, vtkInformation *to)=0

void Remove (vtkInformation *info)

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

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

~vtkInformationKey ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkInformationKey * SafeDownCast (vtkObject *o)

Protected Member Functions

void SetAsObjectBase (vtkInformation *info, vtkObjectBase *value)

vtkObjectBase * GetAsObjectBase (vtkInformation *info)

void ConstructClass (const char *)

Protected Attributes

const char * Name

const char * Location

Member Typedef Documentation

typedef vtkObjectBase vtkInformationKey::Superclass

Reimplemented in vtkInformationDataObjectKey, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.
Definition at line 50 of file vtkInformationKey.h.

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, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

int vtkInformationKey::IsTypeOf ( const char * type ) [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, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

virtual int vtkInformationKey::IsA ( const char * type ) [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, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

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

Reimplemented in vtkInformationDataObjectKey, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

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, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

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::Copy ( 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, vtkInformationDoubleVectorKey, vtkInformationExecutiveKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, and vtkInformationStringKey.

void vtkInformationKey::Remove ( vtkInformation * info )

Remove this key from the given information object.

virtual void vtkInformationKey::Report ( vtkInformation * info,

vtkGarbageCollector * collector

) [virtual]

Report a reference this key has in the given information object.
Reimplemented in vtkInformationDataObjectKey, vtkInformationExecutiveKey, vtkInformationInformationVectorKey, and vtkInformationObjectBaseKey.

void vtkInformationKey::SetAsObjectBase ( vtkInformation * info,

vtkObjectBase * value

) [protected]

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

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

Member Data Documentation

const char* vtkInformationKey::Name [protected]

Definition at line 89 of file vtkInformationKey.h.

const char* vtkInformationKey::Location [protected]

Definition at line 90 of file vtkInformationKey.h.

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

dox/Filtering/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	Copy (vtkInformation from, vtkInformation to)=0
void	Remove (vtkInformation *info)
virtual void	Report (vtkInformation info, vtkGarbageCollector collector)

	vtkInformationKey (const char name, const char location)
	~vtkInformationKey ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkInformationKey *	SafeDownCast (vtkObject *o)
Protected Member Functions
void	SetAsObjectBase (vtkInformation info, vtkObjectBase value)
vtkObjectBase *	GetAsObjectBase (vtkInformation *info)
void	ConstructClass (const char *)
Protected Attributes
const char *	Name
const char *	Location