VTK
vtkPDataSetWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPDataSetWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 =========================================================================*/
26 #ifndef vtkPDataSetWriter_h
27 #define vtkPDataSetWriter_h
28 
29 #include "vtkIOParallelModule.h" // For export macro
30 #include "vtkDataSetWriter.h"
31 
32 #include <map> // for keeping track of extents
33 #include <vector> // for keeping track of extents
34 
35 class vtkImageData;
36 class vtkRectilinearGrid;
37 class vtkStructuredGrid;
39 
40 class VTKIOPARALLEL_EXPORT vtkPDataSetWriter : public vtkDataSetWriter
41 {
42 public:
43  void PrintSelf(ostream& os, vtkIndent indent);
46 
50  virtual int Write();
51 
53 
56  void SetNumberOfPieces(int num);
57  vtkGetMacro(NumberOfPieces, int);
59 
61 
65  vtkSetMacro(GhostLevel, int);
66  vtkGetMacro(GhostLevel, int);
68 
70 
76  vtkSetMacro(StartPiece, int);
77  vtkGetMacro(StartPiece, int);
78  vtkSetMacro(EndPiece, int);
79  vtkGetMacro(EndPiece, int);
81 
83 
87  vtkSetStringMacro(FilePattern);
88  vtkGetStringMacro(FilePattern);
90 
92 
98  vtkSetMacro(UseRelativeFileNames, int);
99  vtkGetMacro(UseRelativeFileNames, int);
100  vtkBooleanMacro(UseRelativeFileNames, int);
102 
104 
110  vtkGetObjectMacro(Controller, vtkMultiProcessController);
112 
113 protected:
116 
117  ostream *OpenFile();
119  char *root, char *str, ostream *fptr);
121  char *root, char *str, ostream *fptr);
123  char *root, char *str, ostream *fptr);
125  char *root, char *str, ostream *fptr);
126 
128  int EndPiece;
131 
133 
134  char *FilePattern;
135 
136  void DeleteFiles();
137 
138  typedef std::map<int, std::vector<int> > ExtentsType;
140 
142 
143 private:
144  vtkPDataSetWriter(const vtkPDataSetWriter&) VTK_DELETE_FUNCTION;
145  void operator=(const vtkPDataSetWriter&) VTK_DELETE_FUNCTION;
146 };
147 
148 #endif
vtkPDataSetWriter::WriteImageMetaData
int WriteImageMetaData(vtkImageData *input, char *root, char *str, ostream *fptr)
vtkPDataSetWriter::New
static vtkPDataSetWriter * New()
vtkPDataSetWriter::SetNumberOfPieces
void SetNumberOfPieces(int num)
This is how many pieces the whole data set will be divided into.
vtkPDataSetWriter::OpenFile
ostream * OpenFile()
vtkPDataSetWriter::NumberOfPieces
int NumberOfPieces
Definition: vtkPDataSetWriter.h:129
vtkRectilinearGrid
a dataset that is topologically regular with variable spacing in the three coordinate directions
Definition: vtkRectilinearGrid.h:57
vtkPDataSetWriter::SetController
virtual void SetController(vtkMultiProcessController *)
Controller used to communicate data type of blocks.
vtkDataSetWriter.h
vtkStructuredGrid
topologically regular array of data
Definition: vtkStructuredGrid.h:64
vtkPDataSetWriter::StartPiece
int StartPiece
Definition: vtkPDataSetWriter.h:127
vtkPDataSetWriter
Manages writing pieces of a data set.
Definition: vtkPDataSetWriter.h:41
vtkPDataSetWriter::ExtentsType
std::map< int, std::vector< int > > ExtentsType
Definition: vtkPDataSetWriter.h:138
vtkDataSetWriter
write any type of vtk dataset to file
Definition: vtkDataSetWriter.h:34
vtkPDataSetWriter::DeleteFiles
void DeleteFiles()
vtkMultiProcessController
Multiprocessing communication superclass.
Definition: vtkMultiProcessController.h:83
vtkPDataSetWriter::WriteUnstructuredMetaData
int WriteUnstructuredMetaData(vtkDataSet *input, char *root, char *str, ostream *fptr)
vtkPDataSetWriter::~vtkPDataSetWriter
~vtkPDataSetWriter()
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPDataSetWriter::EndPiece
int EndPiece
Definition: vtkPDataSetWriter.h:128
vtkPDataSetWriter::WriteStructuredGridMetaData
int WriteStructuredGridMetaData(vtkStructuredGrid *input, char *root, char *str, ostream *fptr)
vtkPDataSetWriter::FilePattern
char * FilePattern
Definition: vtkPDataSetWriter.h:134
vtkPDataSetWriter::GhostLevel
int GhostLevel
Definition: vtkPDataSetWriter.h:130
vtkPDataSetWriter::Extents
ExtentsType Extents
Definition: vtkPDataSetWriter.h:139
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkPDataSetWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkPDataSetWriter::vtkPDataSetWriter
vtkPDataSetWriter()
vtkPDataSetWriter::Write
virtual int Write()
Write the pvtk file and cooresponding vtk files.
vtkPDataSetWriter::WriteRectilinearGridMetaData
int WriteRectilinearGridMetaData(vtkRectilinearGrid *input, char *root, char *str, ostream *fptr)
vtkPDataSetWriter::UseRelativeFileNames
int UseRelativeFileNames
Definition: vtkPDataSetWriter.h:132
vtkPDataSetWriter::Controller
vtkMultiProcessController * Controller
Definition: vtkPDataSetWriter.h:141