vtkCPDataDescription.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkCPDataDescription.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 vtkCPDataDescription_h
16 #define vtkCPDataDescription_h
17 
18 #include "vtkObject.h"
19 #include "vtkPVCatalystModule.h" // needed for exports
20 
21 class vtkFieldData;
23 
28 {
29 public:
30  static vtkCPDataDescription* New();
32  void PrintSelf(ostream& os, vtkIndent indent) override;
33 
35  void SetTimeData(double time, vtkIdType timeStep);
36 
38  vtkGetMacro(TimeStep, vtkIdType);
39 
41  vtkGetMacro(Time, double);
42 
47  vtkSetMacro(ForceOutput, bool);
48 
53  vtkBooleanMacro(ForceOutput, bool);
54 
56  vtkGetMacro(ForceOutput, bool);
57 
61  void AddInput(const char* gridName);
62 
64  unsigned int GetNumberOfInputDescriptions();
65 
68  void ResetInputDescriptions();
69 
74  void ResetAll();
75 
77  vtkCPInputDataDescription* GetInputDescription(unsigned int);
78 
80  const char* GetInputDescriptionName(unsigned int);
81 
83  vtkCPInputDataDescription* GetInputDescriptionByName(const char*);
84 
86  bool GetIfGridIsNecessary(const char*);
87 
89  bool GetIfAnyGridNecessary();
90 
93  void SetUserData(vtkFieldData* UserData);
94 
97  vtkGetObjectMacro(UserData, vtkFieldData);
98 
101  void Copy(vtkCPDataDescription*);
102 
103 protected:
105  virtual ~vtkCPDataDescription();
106 
107 private:
109  void operator=(const vtkCPDataDescription&) = delete;
110 
112  double Time;
113 
115  vtkIdType TimeStep;
116 
118  bool IsTimeDataSet;
119 
124  bool ForceOutput;
125 
129  vtkFieldData* UserData;
130 
131  class vtkInternals;
132  vtkInternals* Internals;
133 };
134 
135 #endif
This class provides the data description for each input for the coprocessor pipelines.
void PrintSelf(ostream &os, vtkIndent indent) VTK_OVERRIDE
int vtkIdType
#define VTKPVCATALYST_EXPORT
static vtkObject * New()
void operator=(const vtkObjectBase &)
This class provides the description of the data for the coprocessor pipelines.