VTK  9.2.6
vtkParticleReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkParticleReader.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 =========================================================================*/
59 #ifndef vtkParticleReader_h
60 #define vtkParticleReader_h
61 
62 #include "vtkIOGeometryModule.h" // For export macro
63 #include "vtkPolyDataAlgorithm.h"
64 
65 #define VTK_FILE_BYTE_ORDER_BIG_ENDIAN 0
66 #define VTK_FILE_BYTE_ORDER_LITTLE_ENDIAN 1
67 
68 class VTKIOGEOMETRY_EXPORT vtkParticleReader : public vtkPolyDataAlgorithm
69 {
70 public:
73  void PrintSelf(ostream& os, vtkIndent indent) override;
74 
76 
82 
84 
101  void SetDataByteOrder(int);
104 
106 
110  vtkSetMacro(SwapBytes, vtkTypeBool);
111  vtkTypeBool GetSwapBytes() { return this->SwapBytes; }
112  vtkBooleanMacro(SwapBytes, vtkTypeBool);
114 
116 
119  vtkSetMacro(HasScalar, vtkTypeBool);
120  vtkGetMacro(HasScalar, vtkTypeBool);
121  vtkBooleanMacro(HasScalar, vtkTypeBool);
123 
125 
134  vtkSetClampMacro(FileType, int, FILE_TYPE_IS_UNKNOWN, FILE_TYPE_IS_BINARY);
135  vtkGetMacro(FileType, int);
136  void SetFileTypeToUnknown() { this->SetFileType(FILE_TYPE_IS_UNKNOWN); }
137  void SetFileTypeToText() { this->SetFileType(FILE_TYPE_IS_TEXT); }
138  void SetFileTypeToBinary() { this->SetFileType(FILE_TYPE_IS_BINARY); }
140 
142 
147  vtkSetClampMacro(DataType, int, VTK_FLOAT, VTK_DOUBLE);
148  vtkGetMacro(DataType, int);
149  void SetDataTypeToFloat() { this->SetDataType(VTK_FLOAT); }
150  void SetDataTypeToDouble() { this->SetDataType(VTK_DOUBLE); }
152 
153 protected:
155  ~vtkParticleReader() override;
156 
157  void OpenFile();
158 
159  char* FileName;
160  istream* File;
161 
164 
166 
179 
181 
188 
200 
204  void DoProgressUpdate(size_t& bytesRead, size_t& fileLength);
205 
214  {
215  FILE_TYPE_IS_UNKNOWN = 0,
217  FILE_TYPE_IS_BINARY
218  };
219 
224  int FileType;
228  int DataType;
229 
233  size_t Alliquot;
237  size_t Count;
238 
241 
242 private:
243  vtkParticleReader(const vtkParticleReader&) = delete;
244  void operator=(const vtkParticleReader&) = delete;
245 };
246 
247 #endif
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Read ASCII or binary particle data and (optionally) one scalar value associated with each particle.
void SetDataByteOrder(int)
These methods should be used instead of the SwapBytes methods.
size_t Count
Count of the number of alliquots processed.
size_t Alliquot
Set an alliquot of bytes.
int ProduceOutputFromBinaryFileDouble(vtkInformationVector *outputVector)
This reader assumes that the file is binary and consists of floating point values by default.
int GetDataByteOrder()
These methods should be used instead of the SwapBytes methods.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkTypeBool GetSwapBytes()
Set/Get the byte swapping to explicitly swap the bytes of a file.
int ProduceOutputFromTextFileDouble(vtkInformationVector *outputVector)
The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value ...
void SetFileTypeToText()
Get/Set the file type.
vtkGetFilePathMacro(FileName)
Specify file name.
int FileType
Used to decide which reader should be used.
static vtkParticleReader * New()
vtkSetFilePathMacro(FileName)
Specify file name.
int ProduceOutputFromTextFileFloat(vtkInformationVector *outputVector)
The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value ...
int DetermineFileType()
Determine the type of file based on an analysis of its contents.
FILE_TYPE
Enumerate the supported file types.
void SetDataByteOrderToLittleEndian()
These methods should be used instead of the SwapBytes methods.
void SetDataTypeToDouble()
Get/Set the data type.
void SetFileTypeToBinary()
Get/Set the file type.
void DoProgressUpdate(size_t &bytesRead, size_t &fileLength)
Update of the progress.
void SetDataTypeToFloat()
Get/Set the data type.
~vtkParticleReader() override
const char * GetDataByteOrderAsString()
These methods should be used instead of the SwapBytes methods.
int DataType
Used to specify the data type.
int ProduceOutputFromBinaryFileFloat(vtkInformationVector *outputVector)
This reader assumes that the file is binary and consists of floating point values by default.
void SetFileTypeToUnknown()
Get/Set the file type.
void SetDataByteOrderToBigEndian()
These methods should be used instead of the SwapBytes methods.
Superclass for algorithms that produce only polydata as output.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_DOUBLE
Definition: vtkType.h:55
#define VTK_FLOAT
Definition: vtkType.h:54