ParaView
vtkCPAdaptorAPI.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkCPAdaptorAPI.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 #ifndef vtkCPAdaptorAPI_h
16 #define vtkCPAdaptorAPI_h
17 
18 #include "vtkObject.h"
19 #include "vtkPVCatalystModule.h" // For windows import/export of shared libraries
20 
22 class vtkCPProcessor;
23 class vtkDataSet;
24 
27 class VTKPVCATALYST_EXPORT vtkCPAdaptorAPI : public vtkObject
28 {
29 public:
30  vtkTypeMacro(vtkCPAdaptorAPI, vtkObject);
31 
33  static void CoProcessorInitialize();
34 
36  static void CoProcessorFinalize();
37 
40  static void RequestDataDescription(int* timeStep, double* time, int* coprocessThisTimeStep);
41 
45  static void NeedToCreateGrid(int* needGrid);
46 
49  static void CoProcess();
50 
53 
56 
57 protected:
60 
61  // IsTimeDataSet is meant to be used to make sure that
62  // needtocoprocessthistimestep() is called before
63  // calling any of the other coprocessing functions.
64  // It is reset to falase after calling coprocess as well
65  // as if coprocessing is not needed for this time/time step
66  static bool IsTimeDataSet;
67 };
68 #endif
69 // VTK-HeaderTest-Exclude: vtkCPAdaptorAPI.h
static vtkCPProcessor * CoProcessor
vtkCPAdaptorAPI provides the implementation for API exposed to typical adaptor, such as C...
static vtkCPDataDescription * GetCoProcessorData()
provides access to the vtkCPDataDescription instance.
static vtkCPDataDescription * CoProcessorData
There are 3 distinct phases for the operation of a co-processor.
static vtkCPProcessor * GetCoProcessor()
provides access to the vtkCPProcessor instance.
This class provides the description of the data for the coprocessor pipelines.
static bool IsTimeDataSet