vtkInformationKey Class Reference

#include <vtkInformationKey.h>

Inheritance diagram for vtkInformationKey:

Inheritance graph
[legend]
Collaboration diagram for vtkInformationKey:

Collaboration graph
[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 vtkInformationKeySafeDownCast (vtkObject *o)

Protected Member Functions

void SetAsObjectBase (vtkInformation *info, vtkObjectBase *value)
vtkObjectBaseGetAsObjectBase (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]

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

virtual int vtkInformationKey::IsA ( const char *  name  )  [virtual]

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

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

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]

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.

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

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]

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

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

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

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


Member Data Documentation

const char* vtkInformationKey::Name [protected]

Definition at line 96 of file vtkInformationKey.h.

const char* vtkInformationKey::Location [protected]

Definition at line 97 of file vtkInformationKey.h.


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

Generated on Wed Jun 3 19:12:41 2009 for VTK by  doxygen 1.5.6