vtkCPXMLPWriterPipeline.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
3 #ifndef vtkCPXMLPWriterPipeline_h
4 #define vtkCPXMLPWriterPipeline_h
5 
6 #include "vtkPVCatalystModule.h" // For windows import/export of shared libraries
7 #include <string> // For Path member variable
8 #include <vtkCPPipeline.h>
9 
17 {
18 public:
19  static vtkCPXMLPWriterPipeline* New();
21  void PrintSelf(ostream& os, vtkIndent indent) override;
22 
23  int RequestDataDescription(vtkCPDataDescription* dataDescription) override;
24 
25  int CoProcess(vtkCPDataDescription* dataDescription) override;
26 
28  vtkSetClampMacro(OutputFrequency, int, 1, VTK_INT_MAX);
29  vtkGetMacro(OutputFrequency, int);
30 
33  vtkSetClampMacro(PaddingAmount, int, 1, 10);
34  vtkGetMacro(PaddingAmount, int);
35 
37  vtkSetMacro(Path, std::string);
38  vtkGetMacro(Path, std::string);
39 
40 protected:
42  ~vtkCPXMLPWriterPipeline() override;
43 
44 private:
46  void operator=(const vtkCPXMLPWriterPipeline&) = delete;
47 
48  int OutputFrequency;
49  int PaddingAmount;
50  std::string Path;
51 };
52 #endif
void PrintSelf(ostream &os, vtkIndent indent) override
virtual int RequestDataDescription(vtkCPDataDescription *dataDescription)=0
Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this Tim...
Generic PXML writer pipeline to write out the full Catalyst input datasets.
virtual int CoProcess(vtkCPDataDescription *dataDescription)=0
Execute the pipeline. Returns 1 for success and 0 for failure.
#define VTKPVCATALYST_EXPORT
Generic interface for operating on pipelines.
Definition: vtkCPPipeline.h:17
static vtkObject * New()
This class provides the description of the data for the coprocessor pipelines.