#include <vtkInformationKey.h>
Inheritance diagram for vtkInformationKey:
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 () |
| virtual void | Remove (vtkInformation *info) |
| const char * | GetLocation () |
| vtkInformationKey (const char *name, const char *location) | |
| ~vtkInformationKey () | |
| virtual void | ShallowCopy (vtkInformation *from, vtkInformation *to)=0 |
| virtual void | DeepCopy (vtkInformation *vtkNotUsed(from), vtkInformation *vtkNotUsed(to)) |
| virtual void | Report (vtkInformation *info, vtkGarbageCollector *collector) |
| 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 |
|
|
||||||||||||
|
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. |
|
|
Get the location of the key. This is the name of the class in which the key is defined. |
|
|
|
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, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationRequestKey, vtkInformationStringKey, and vtkInformationUnsignedLongKey. |
|
|
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, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationRequestKey, vtkInformationStringKey, and vtkInformationUnsignedLongKey. |
|
|
||||||||||||
|
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, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationRequestKey, vtkInformationStringKey, and vtkInformationUnsignedLongKey. |
|
|
Prevent normal vtkObject reference counting behavior. Reimplemented from vtkObjectBase. |
|
|
Prevent normal vtkObject reference counting behavior. Reimplemented from vtkObjectBase. |
|
|
Get the name of the key. This is not the type of the key, but the name of the key instance. |
|
|
Get the location of the key. This is the name of the class in which the key is defined. |
|
||||||||||||
|
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, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationIdTypeKey, vtkInformationInformationKey, vtkInformationInformationVectorKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationObjectBaseKey, vtkInformationRequestKey, vtkInformationStringKey, and vtkInformationUnsignedLongKey. |
|
||||||||||||
|
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). Definition at line 76 of file vtkInformationKey.h. |
|
|
Remove this key from the given information object. Reimplemented in vtkInformationExecutivePortVectorKey, and vtkInformationRequestKey. |
|
||||||||||||
|
Report a reference this key has in the given information object. Reimplemented in vtkInformationDataObjectKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationInformationVectorKey, and vtkInformationObjectBaseKey. |
|
|
Print the key's value in an information object to a stream. |
|
||||||||||||
|
Report a reference this key has in the given information object. Reimplemented in vtkInformationDoubleKey, vtkInformationDoubleVectorKey, vtkInformationExecutivePortKey, vtkInformationExecutivePortVectorKey, vtkInformationIdTypeKey, vtkInformationIntegerKey, vtkInformationIntegerPointerKey, vtkInformationIntegerVectorKey, vtkInformationKeyVectorKey, vtkInformationRequestKey, vtkInformationStringKey, and vtkInformationUnsignedLongKey. |
|
||||||||||||
|
|
|
|
|
|
||||||||||||
|
|
|
|
|
|
|
Definition at line 93 of file vtkInformationKey.h. |
|
|
Definition at line 94 of file vtkInformationKey.h. |
1.4.3-20050530