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
37#ifndef vtkParticleReader_h
38#define vtkParticleReader_h
39
40#include "vtkIOGeometryModule.h" // For export macro
42
43#define VTK_FILE_BYTE_ORDER_BIG_ENDIAN 0
44#define VTK_FILE_BYTE_ORDER_LITTLE_ENDIAN 1
45
46VTK_ABI_NAMESPACE_BEGIN
47class VTKIOGEOMETRY_EXPORT vtkParticleReader : public vtkPolyDataAlgorithm
48{
49public:
52 void PrintSelf(ostream& os, vtkIndent indent) override;
53
55
61
63
83
85
89 vtkSetMacro(SwapBytes, vtkTypeBool);
90 vtkTypeBool GetSwapBytes() { return this->SwapBytes; }
91 vtkBooleanMacro(SwapBytes, vtkTypeBool);
93
95
98 vtkSetMacro(HasScalar, vtkTypeBool);
99 vtkGetMacro(HasScalar, vtkTypeBool);
100 vtkBooleanMacro(HasScalar, vtkTypeBool);
102
104
113 vtkSetClampMacro(FileType, int, FILE_TYPE_IS_UNKNOWN, FILE_TYPE_IS_BINARY);
114 vtkGetMacro(FileType, int);
115 void SetFileTypeToUnknown() { this->SetFileType(FILE_TYPE_IS_UNKNOWN); }
116 void SetFileTypeToText() { this->SetFileType(FILE_TYPE_IS_TEXT); }
117 void SetFileTypeToBinary() { this->SetFileType(FILE_TYPE_IS_BINARY); }
119
121
126 vtkSetClampMacro(DataType, int, VTK_FLOAT, VTK_DOUBLE);
127 vtkGetMacro(DataType, int);
128 void SetDataTypeToFloat() { this->SetDataType(VTK_FLOAT); }
129 void SetDataTypeToDouble() { this->SetDataType(VTK_DOUBLE); }
131
132protected:
135
136 void OpenFile();
137
138 char* FileName;
139 istream* File;
140
143
145
158
160
167
179
183 void DoProgressUpdate(size_t& bytesRead, size_t& fileLength);
184
193 {
194 FILE_TYPE_IS_UNKNOWN = 0,
196 FILE_TYPE_IS_BINARY
197 };
198
208
212 size_t Alliquot;
216 size_t Count;
217
220
221private:
222 vtkParticleReader(const vtkParticleReader&) = delete;
223 void operator=(const vtkParticleReader&) = delete;
224};
225
226VTK_ABI_NAMESPACE_END
227#endif
a simple class to control print indentation
Definition vtkIndent.h:38
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.
const char * GetDataByteOrderAsString()
These methods should be used instead of the SwapBytes methods.
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.
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
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.
static vtkParticleReader * New()
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