Superclass for vtkInformation keys. More...
#include <vtkInformationKey.h>
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) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkInformationKey * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| 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 | |
| const char * | Name |
| const 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
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
Definition at line 40 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.
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.
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| 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.
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| static vtkInformationKey* vtkInformationKey::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| virtual vtkObjectBase* vtkInformationKey::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| vtkInformationKey* vtkInformationKey::NewInstance | ( | ) | const |
Reimplemented in vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| 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 vtkInformationVariantKey, vtkInformationVariantVectorKey, vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationStringKey, vtkInformationStringVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationDataObjectKey, vtkInformationInformationVectorKey, vtkInformationObjectBaseKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, and vtkInformationUnsignedLongKey.
| 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, vtkInformationKeyVectorKey, vtkInformationStringVectorKey, vtkInformationVariantKey, vtkInformationExecutivePortKey, vtkInformationDataObjectKey, vtkInformationDoubleKey, vtkInformationIntegerPointerKey, vtkInformationObjectBaseKey, vtkInformationStringKey, vtkInformationInformationVectorKey, vtkInformationRequestKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationIntegerKey, and vtkInformationUnsignedLongKey.
| 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, vtkInformationInformationVectorKey, and vtkInformationInformationKey.
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, vtkInformationInformationVectorKey, vtkInformationExecutivePortKey, vtkInformationDataObjectKey, and vtkInformationObjectBaseKey.
| 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.
Reimplemented in vtkInformationQuadratureSchemeDefinitionVectorKey, vtkInformationObjectBaseVectorKey, vtkInformationExecutivePortVectorKey, vtkInformationVariantVectorKey, vtkInformationDoubleVectorKey, vtkInformationExecutivePortKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationStringVectorKey, vtkInformationVariantKey, vtkInformationDoubleKey, vtkInformationIntegerPointerKey, vtkInformationStringKey, vtkInformationRequestKey, vtkInformationIdTypeKey, vtkInformationIntegerKey, and vtkInformationUnsignedLongKey.
| 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
const char* vtkInformationKey::Name [protected] |
Definition at line 97 of file vtkInformationKey.h.
const char* vtkInformationKey::Location [protected] |
Definition at line 98 of file vtkInformationKey.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkInformationKey.h
