VTK  9.3.0
vtkParticleReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
28 #ifndef vtkParticleReader_h
29 #define vtkParticleReader_h
30 
31 #include "vtkIOGeometryModule.h" // For export macro
32 #include "vtkPolyDataAlgorithm.h"
33 
34 #define VTK_FILE_BYTE_ORDER_BIG_ENDIAN 0
35 #define VTK_FILE_BYTE_ORDER_LITTLE_ENDIAN 1
36 
37 VTK_ABI_NAMESPACE_BEGIN
38 class VTKIOGEOMETRY_EXPORT vtkParticleReader : public vtkPolyDataAlgorithm
39 {
40 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
52 
54 
71  void SetDataByteOrder(int);
72  const char* GetDataByteOrderAsString();
74 
76 
80  vtkSetMacro(SwapBytes, vtkTypeBool);
81  vtkTypeBool GetSwapBytes() { return this->SwapBytes; }
82  vtkBooleanMacro(SwapBytes, vtkTypeBool);
84 
86 
89  vtkSetMacro(HasScalar, vtkTypeBool);
90  vtkGetMacro(HasScalar, vtkTypeBool);
91  vtkBooleanMacro(HasScalar, vtkTypeBool);
93 
95 
104  vtkSetClampMacro(FileType, int, FILE_TYPE_IS_UNKNOWN, FILE_TYPE_IS_BINARY);
105  vtkGetMacro(FileType, int);
106  void SetFileTypeToUnknown() { this->SetFileType(FILE_TYPE_IS_UNKNOWN); }
107  void SetFileTypeToText() { this->SetFileType(FILE_TYPE_IS_TEXT); }
108  void SetFileTypeToBinary() { this->SetFileType(FILE_TYPE_IS_BINARY); }
110 
112 
117  vtkSetClampMacro(DataType, int, VTK_FLOAT, VTK_DOUBLE);
118  vtkGetMacro(DataType, int);
119  void SetDataTypeToFloat() { this->SetDataType(VTK_FLOAT); }
120  void SetDataTypeToDouble() { this->SetDataType(VTK_DOUBLE); }
122 
123 protected:
125  ~vtkParticleReader() override;
126 
127  void OpenFile();
128 
129  char* FileName;
130  istream* File;
131 
134 
136 
149 
151 
158 
170 
174  void DoProgressUpdate(size_t& bytesRead, size_t& fileLength);
175 
184  {
185  FILE_TYPE_IS_UNKNOWN = 0,
187  FILE_TYPE_IS_BINARY
188  };
189 
194  int FileType;
198  int DataType;
199 
203  size_t Alliquot;
207  size_t Count;
208 
211 
212 private:
213  vtkParticleReader(const vtkParticleReader&) = delete;
214  void operator=(const vtkParticleReader&) = delete;
215 };
216 
217 VTK_ABI_NAMESPACE_END
218 #endif
a simple class to control print indentation
Definition: vtkIndent.h:29
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:64
#define VTK_DOUBLE
Definition: vtkType.h:43
#define VTK_FLOAT
Definition: vtkType.h:42