vtkCPXMLPWriterPipeline.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkCPXMLPWriterPipeline.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 vtkCPXMLPWriterPipeline_h
16 #define vtkCPXMLPWriterPipeline_h
17 
18 #include "vtkPVCatalystModule.h" // For windows import/export of shared libraries
19 #include <string> // For Path member variable
20 #include <vtkCPPipeline.h>
21 
29 {
30 public:
31  static vtkCPXMLPWriterPipeline* New();
33  void PrintSelf(ostream& os, vtkIndent indent) override;
34 
35  int RequestDataDescription(vtkCPDataDescription* dataDescription) override;
36 
37  int CoProcess(vtkCPDataDescription* dataDescription) override;
38 
40  vtkSetClampMacro(OutputFrequency, int, 1, VTK_INT_MAX);
41  vtkGetMacro(OutputFrequency, int);
42 
45  vtkSetClampMacro(PaddingAmount, int, 1, 10);
46  vtkGetMacro(PaddingAmount, int);
47 
49  vtkSetMacro(Path, std::string);
50  vtkGetMacro(Path, std::string);
51 
52 protected:
54  virtual ~vtkCPXMLPWriterPipeline();
55 
56 private:
58  void operator=(const vtkCPXMLPWriterPipeline&) = delete;
59 
60  int OutputFrequency;
61  int PaddingAmount;
62  std::string Path;
63 };
64 #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:29
static vtkObject * New()
This class provides the description of the data for the coprocessor pipelines.