key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vtkInformationIntegerKey that can used to request integer values from upstream. A good example of this is UPDATE_NUMBER_OF_PIECES where downstream can request that upstream provides data partitioned into a certain number of pieces. There are several components that make this work. First, the key will copy itself upstream during REQUEST_UPDATE_EXTENT. Second, after a successfull execution, it will stor its value into a data object's information using a specific key defined by its data member DataKey. Third, before execution, it will check if the requested value matched the value in the data object's information. If not, it will ask the pipeline to execute. More...
#include <vtkInformationIntegerRequestKey.h>
Public Types | |
| typedef vtkInformationIntegerKey | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkInformationIntegerRequestKey * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| vtkInformationIntegerRequestKey (const char *name, const char *location) | |
| ~vtkInformationIntegerRequestKey () | |
| virtual bool | NeedToExecute (vtkInformation *pipelineInfo, vtkInformation *dobjInfo) |
| virtual void | StoreMetaData (vtkInformation *request, vtkInformation *pipelineInfo, vtkInformation *dobjInfo) |
| virtual void | CopyDefaultInformation (vtkInformation *request, vtkInformation *fromInfo, vtkInformation *toInfo) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkInformationIntegerRequestKey * | SafeDownCast (vtkObjectBase *o) |
| static vtkInformationIntegerRequestKey * | MakeKey (const char *name, const char *location) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
Protected Attributes | |
| vtkInformationIntegerKey * | DataKey |
Detailed Description
key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vtkInformationIntegerKey that can used to request integer values from upstream. A good example of this is UPDATE_NUMBER_OF_PIECES where downstream can request that upstream provides data partitioned into a certain number of pieces. There are several components that make this work. First, the key will copy itself upstream during REQUEST_UPDATE_EXTENT. Second, after a successfull execution, it will stor its value into a data object's information using a specific key defined by its data member DataKey. Third, before execution, it will check if the requested value matched the value in the data object's information. If not, it will ask the pipeline to execute.
The best way to use this class is to subclass it to set the DataKey data member. This is usually done in the subclass' constructor.
Definition at line 43 of file vtkInformationIntegerRequestKey.h.
Member Typedef Documentation
Reimplemented from vtkInformationIntegerKey.
Definition at line 46 of file vtkInformationIntegerRequestKey.h.
Constructor & Destructor Documentation
| vtkInformationIntegerRequestKey::vtkInformationIntegerRequestKey | ( | const char * | name, |
| const char * | location | ||
| ) |
Member Function Documentation
| static int vtkInformationIntegerRequestKey::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 vtkInformationIntegerKey.
| virtual int vtkInformationIntegerRequestKey::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 vtkInformationIntegerKey.
| static vtkInformationIntegerRequestKey* vtkInformationIntegerRequestKey::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkInformationIntegerKey.
| virtual vtkObjectBase* vtkInformationIntegerRequestKey::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkInformationIntegerKey.
Reimplemented from vtkInformationIntegerKey.
| void vtkInformationIntegerRequestKey::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 vtkInformationIntegerKey.
| static vtkInformationIntegerRequestKey* vtkInformationIntegerRequestKey::MakeKey | ( | const char * | name, |
| const char * | location | ||
| ) | [inline, static] |
This method simply returns a new vtkInformationIntegerRequestKey, given a name and a location. This method is provided for wrappers. Use the constructor directly from C++ instead.
Reimplemented from vtkInformationIntegerKey.
Definition at line 56 of file vtkInformationIntegerRequestKey.h.
| virtual bool vtkInformationIntegerRequestKey::NeedToExecute | ( | vtkInformation * | pipelineInfo, |
| vtkInformation * | dobjInfo | ||
| ) | [virtual] |
Returns true if a value of type DataKey does not exist in dobjInfo or if it is different that the value stored in pipelineInfo using this key.
| virtual void vtkInformationIntegerRequestKey::StoreMetaData | ( | vtkInformation * | request, |
| vtkInformation * | pipelineInfo, | ||
| vtkInformation * | dobjInfo | ||
| ) | [virtual] |
Copies the value stored in pipelineInfo using this key into dobjInfo.
| virtual void vtkInformationIntegerRequestKey::CopyDefaultInformation | ( | vtkInformation * | request, |
| vtkInformation * | fromInfo, | ||
| vtkInformation * | toInfo | ||
| ) | [virtual] |
Copies the value stored in fromInfo using this key into toInfo if request has the REQUEST_UPDATE_EXTENT key.
Member Data Documentation
Definition at line 86 of file vtkInformationIntegerRequestKey.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Common/ExecutionModel/vtkInformationIntegerRequestKey.h
