key used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInformationDataObjectKey that (shallow) copies itself downstream during the REQUEST_INFORMATION pass. More...
#include <vtkInformationDataObjectMetaDataKey.h>
Inheritance diagram for vtkInformationDataObjectMetaDataKey:
Collaboration diagram for vtkInformationDataObjectMetaDataKey:
Public Types | |
| typedef vtkInformationDataObjectKey | Superclass |
 Public Types inherited from vtkInformationDataObjectKey | |
| typedef vtkInformationKey | Superclass |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkInformationDataObjectMetaDataKey * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| vtkInformationDataObjectMetaDataKey (const char *name, const char *location) | |
| ~vtkInformationDataObjectMetaDataKey () override | |
| void | CopyDefaultInformation (vtkInformation *request, vtkInformation *fromInfo, vtkInformation *toInfo) override |
| Simply shallow copies the key from fromInfo to toInfo if request has the REQUEST_INFORMATION() key. More... | |
| Public Member Functions inherited from vtkInformationDataObjectKey | |
| vtkInformationDataObjectKey * | NewInstance () const |
| vtkInformationDataObjectKey (const char *name, const char *location) | |
| ~vtkInformationDataObjectKey () override | |
| void | ShallowCopy (vtkInformation *from, vtkInformation *to) override |
| Copy the entry associated with this key from one information object to another. More... | |
| void | Report (vtkInformation *info, vtkGarbageCollector *collector) override |
| Report a reference this key has in the given information object. More... | |
| void | Set (vtkInformation *info, vtkDataObject *) |
| Get/Set the value associated with this key in the given information object. More... | |
| vtkDataObject * | Get (vtkInformation *info) |
| Get/Set the value associated with this key in the given information object. More... | |
| Public Member Functions inherited from vtkInformationKey | |
| vtkBaseTypeMacro (vtkInformationKey, vtkObjectBase) | |
| void | Register (vtkObjectBase *) override |
| Prevent normal vtkObject reference counting behavior. More... | |
| void | UnRegister (vtkObjectBase *) override |
| Prevent normal vtkObject reference counting behavior. More... | |
| const char * | GetName () |
| Get the name of the key. More... | |
| const char * | GetLocation () |
| Get the location of the key. More... | |
| virtual void | DeepCopy (vtkInformation *from, vtkInformation *to) |
| 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). More... | |
| virtual int | Has (vtkInformation *info) |
| Check whether this key appears in the given information object. More... | |
| virtual void | Remove (vtkInformation *info) |
| Remove this key from the given information object. More... | |
| virtual bool | NeedToExecute (vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo)) |
| This function is only relevant when the pertaining key is used in a VTK pipeline. More... | |
| virtual void | StoreMetaData (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(pipelineInfo), vtkInformation *vtkNotUsed(dobjInfo)) |
| This function is only relevant when the pertaining key is used in a VTK pipeline. More... | |
| virtual void | CopyDefaultInformation (vtkInformation *vtkNotUsed(request), vtkInformation *vtkNotUsed(fromInfo), vtkInformation *vtkNotUsed(toInfo)) |
| This function is only relevant when the pertaining key is used in a VTK pipeline. More... | |
| vtkInformationKey (const char *name, const char *location) | |
| Key instances are static data that need to be created and destroyed. More... | |
| ~vtkInformationKey () override | |
| Key instances are static data that need to be created and destroyed. More... | |
| void | Print (vtkInformation *info) |
| Print the key's value in an information object to a stream. More... | |
| virtual void | Print (ostream &os, vtkInformation *info) |
| Print the key's value in an information object to a stream. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkInformationDataObjectMetaDataKey * | SafeDownCast (vtkObjectBase *o) |
| static vtkInformationDataObjectMetaDataKey * | MakeKey (const char *name, const char *location) |
| This method simply returns a new vtkInformationDataObjectMetaDataKey, given a name and a location. More... | |
| Static Public Member Functions inherited from vtkInformationDataObjectKey | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkInformationDataObjectKey * | SafeDownCast (vtkObjectBase *o) |
| static vtkInformationDataObjectKey * | MakeKey (const char *name, const char *location) |
| This method simply returns a new vtkInformationDataObjectKey, given a name and a location. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| Protected Member Functions inherited from vtkInformationKey | |
| vtkInformationKeySetStringMacro (Name) | |
| vtkInformationKeySetStringMacro (Location) | |
| 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 Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
| virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
| Protected Attributes inherited from vtkInformationKey | |
| char * | Name |
| char * | Location |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
key used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInformationDataObjectKey that (shallow) copies itself downstream during the REQUEST_INFORMATION pass.
Hence it can be used to provide meta-data of type vtkDataObject or any subclass.
Definition at line 34 of file vtkInformationDataObjectMetaDataKey.h.
Member Typedef Documentation
Definition at line 37 of file vtkInformationDataObjectMetaDataKey.h.
Constructor & Destructor Documentation
| vtkInformationDataObjectMetaDataKey::vtkInformationDataObjectMetaDataKey | ( | const char * | name, |
| const char * | location | ||
| ) |
|
override |
Member Function Documentation
|
static |
|
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 vtkInformationDataObjectKey.
|
static |
|
protectedvirtual |
Reimplemented from vtkInformationDataObjectKey.
| vtkInformationDataObjectMetaDataKey* vtkInformationDataObjectMetaDataKey::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkInformationDataObjectKey.
|
inlinestatic |
This method simply returns a new vtkInformationDataObjectMetaDataKey, given a name and a location.
This method is provided for wrappers. Use the constructor directly from C++ instead.
Definition at line 48 of file vtkInformationDataObjectMetaDataKey.h.
|
override |
Simply shallow copies the key from fromInfo to toInfo if request has the REQUEST_INFORMATION() key.
This is used by the pipeline to propagate this key downstream.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/ExecutionModel/vtkInformationDataObjectMetaDataKey.h
