VTK
vtkAbstractParticleWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAbstractParticleWriter.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 =========================================================================*/
31 #ifndef vtkAbstractParticleWriter_h
32 #define vtkAbstractParticleWriter_h
33 
34 #include "vtkIOCoreModule.h" // For export macro
35 #include "vtkWriter.h"
36 
37 class VTKIOCORE_EXPORT vtkAbstractParticleWriter : public vtkWriter
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
44 
47  vtkSetMacro(TimeStep, int);
48  vtkGetMacro(TimeStep, int);
50 
52 
58  vtkSetMacro(TimeValue,double);
59  vtkGetMacro(TimeValue,double);
61 
63 
66  vtkSetStringMacro(FileName);
67  vtkGetStringMacro(FileName);
69 
71 
75  vtkSetMacro(CollectiveIO,int);
76  vtkGetMacro(CollectiveIO,int);
77  void SetWriteModeToCollective();
78  void SetWriteModeToIndependent();
80 
85  virtual void CloseFile() = 0;
86 
87 protected:
89  ~vtkAbstractParticleWriter() override;
90 
91  void WriteData() override = 0; //internal method subclasses must respond to
93  int TimeStep;
94  double TimeValue;
95  char *FileName;
96 
97 private:
99  void operator=(const vtkAbstractParticleWriter&) = delete;
100 };
101 
102 #endif
vtkWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkWriter::WriteData
virtual void WriteData()=0
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:42
vtkAbstractParticleWriter
abstract class to write particle data to file
Definition: vtkAbstractParticleWriter.h:37
vtkAbstractParticleWriter::TimeValue
double TimeValue
Definition: vtkAbstractParticleWriter.h:94
vtkAbstractParticleWriter::CollectiveIO
int CollectiveIO
Definition: vtkAbstractParticleWriter.h:92
vtkWriter.h
vtkAbstractParticleWriter::TimeStep
int TimeStep
Definition: vtkAbstractParticleWriter.h:93
vtkAbstractParticleWriter::FileName
char * FileName
Definition: vtkAbstractParticleWriter.h:95