This class provides the description of the data for the coprocessor pipelines. More...
#include <vtkCPDataDescription.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | SetTimeData (double time, vtkIdType timeStep) |
| Set the time step and current simulation time. | |
| virtual vtkIdType | GetTimeStep () |
| Get the current time step that should be set in the adaptor. | |
| virtual double | GetTime () |
| Get the current time that should be set in the adaptor. | |
| virtual void | SetForceOutput (bool) |
| Specify whether or not to force output of all coprocessing pipelines. | |
| virtual void | ForceOutputOn () |
| Specify whether or not to force output of all coprocessing pipelines. | |
| virtual void | ForceOutputOff () |
| virtual bool | GetForceOutput () |
| Return whether or not output is forced for all coprocessing pipelines. | |
| void | AddInput (const char *gridName) |
| Add names for grids produced by the simulation. | |
| unsigned int | GetNumberOfInputDescriptions () |
| Returns the number of input descriptions. | |
| void | ResetInputDescriptions () |
| Reset the names of the fields that are needed, the required meshes, etc. | |
| void | ResetAll () |
| Reset the names of the fields that are needed, the required meshes, etc. | |
| vtkCPInputDataDescription * | GetInputDescription (unsigned int) |
| Provides access to a grid description using the index. | |
| vtkCPInputDataDescription * | GetInputDescriptionByName (const char *) |
| Provides access to a grid description using the grid name. | |
| bool | GetIfGridIsNecessary (const char *) |
| Returns true if the grid is necessary, given the grid's name. | |
| bool | GetIfAnyGridNecessary () |
| Returns true if any of the grids is necessary. | |
| void | SetUserData (vtkFieldData *UserData) |
| Set user defined information that can be passed from the adaptor to the coprocessing pipelines. | |
| virtual vtkFieldData * | GetUserData () |
| Set user defined information that can be passed from the adaptor to the coprocessing pipelines. | |
Static Public Member Functions | |
| static vtkCPDataDescription * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkCPDataDescription * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkCPDataDescription () | |
| virtual | ~vtkCPDataDescription () |
Detailed Description
This class provides the description of the data for the coprocessor pipelines.
Definition at line 27 of file vtkCPDataDescription.h.
Constructor & Destructor Documentation
| vtkCPDataDescription::vtkCPDataDescription | ( | ) | [protected] |
| virtual vtkCPDataDescription::~vtkCPDataDescription | ( | ) | [protected, virtual] |
Member Function Documentation
| static vtkCPDataDescription* vtkCPDataDescription::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkCPDataDescription::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkCPDataDescription::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
| static vtkCPDataDescription* vtkCPDataDescription::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkCPDataDescription::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
Set the time step and current simulation time.
| virtual vtkIdType vtkCPDataDescription::GetTimeStep | ( | ) | [virtual] |
Get the current time step that should be set in the adaptor.
| virtual double vtkCPDataDescription::GetTime | ( | ) | [virtual] |
Get the current time that should be set in the adaptor.
| virtual void vtkCPDataDescription::SetForceOutput | ( | bool | ) | [virtual] |
Specify whether or not to force output of all coprocessing pipelines.
This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.
| virtual void vtkCPDataDescription::ForceOutputOn | ( | ) | [virtual] |
Specify whether or not to force output of all coprocessing pipelines.
This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.
| virtual void vtkCPDataDescription::ForceOutputOff | ( | ) | [virtual] |
| virtual bool vtkCPDataDescription::GetForceOutput | ( | ) | [virtual] |
Return whether or not output is forced for all coprocessing pipelines.
| void vtkCPDataDescription::AddInput | ( | const char * | gridName | ) |
Add names for grids produced by the simulation.
This allocates a new vtkCPInputDataDescription for that grid, if a grid by that name does not already exist.
| unsigned int vtkCPDataDescription::GetNumberOfInputDescriptions | ( | ) |
Returns the number of input descriptions.
| void vtkCPDataDescription::ResetInputDescriptions | ( | ) |
Reset the names of the fields that are needed, the required meshes, etc.
that are stored in the vtkCPInputDescriptions.
| void vtkCPDataDescription::ResetAll | ( | ) |
Reset the names of the fields that are needed, the required meshes, etc.
that are stored in the vtkCPInputDescriptions as well as the time information and output forcing. Automatically called after vtkCPProcessor::CoProcess() is called.
| vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescription | ( | unsigned | int | ) |
Provides access to a grid description using the index.
| vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescriptionByName | ( | const char * | ) |
Provides access to a grid description using the grid name.
| bool vtkCPDataDescription::GetIfGridIsNecessary | ( | const char * | ) |
Returns true if the grid is necessary, given the grid's name.
| bool vtkCPDataDescription::GetIfAnyGridNecessary | ( | ) |
Returns true if any of the grids is necessary.
| void vtkCPDataDescription::SetUserData | ( | vtkFieldData * | UserData | ) |
Set user defined information that can be passed from the adaptor to the coprocessing pipelines.
| virtual vtkFieldData* vtkCPDataDescription::GetUserData | ( | ) | [virtual] |
Set user defined information that can be passed from the adaptor to the coprocessing pipelines.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/CoProcessing/CoProcessor/vtkCPDataDescription.h
