VTK
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 =========================================================================*/
39 #ifndef vtkParticleReader_h
40 #define vtkParticleReader_h
41 
42 #include "vtkIOGeometryModule.h" // For export macro
43 #include "vtkPolyDataAlgorithm.h"
44 
45 #define VTK_FILE_BYTE_ORDER_BIG_ENDIAN 0
46 #define VTK_FILE_BYTE_ORDER_LITTLE_ENDIAN 1
47 
48 
50 {
51 public:
54  void PrintSelf(ostream& os, vtkIndent indent);
55 
57 
58  vtkSetStringMacro(FileName);
59  vtkGetStringMacro(FileName);
61 
63 
77  void SetDataByteOrder(int);
78  const char *GetDataByteOrderAsString();
80 
82 
84  vtkSetMacro(SwapBytes,int);
85  int GetSwapBytes() {return this->SwapBytes;}
86  vtkBooleanMacro(SwapBytes,int);
88 
90 
91  vtkSetMacro(HasScalar,int);
92  vtkGetMacro(HasScalar,int);
93  vtkBooleanMacro(HasScalar,int);
95 
97 
101  vtkSetClampMacro(FileType, int, FILE_TYPE_IS_UNKNOWN, FILE_TYPE_IS_BINARY);
102  vtkGetMacro(FileType, int);
103  void SetFileTypeToUnknown() {this->SetFileType(FILE_TYPE_IS_UNKNOWN);}
104  void SetFileTypeToText() {this->SetFileType(FILE_TYPE_IS_TEXT);}
105  void SetFileTypeToBinary() {this->SetFileType(FILE_TYPE_IS_BINARY);}
107 
109 
113  vtkGetMacro(DataType, int);
114  void SetDataTypeToFloat() {this->SetDataType(VTK_FLOAT);}
115  void SetDataTypeToDouble() {this->SetDataType(VTK_DOUBLE);}
117 
118 
119 protected:
122 
123  void OpenFile();
124 
125  char *FileName;
126  ifstream *File;
127 
130 
132 
143 
145 
150 
161 
163  void DoProgressUpdate( size_t & bytesRead, size_t & fileLength );
164 
165  //BTX
167 
171  enum FILE_TYPE { FILE_TYPE_IS_UNKNOWN = 0,
172  FILE_TYPE_IS_TEXT, FILE_TYPE_IS_BINARY };
173  //ETX
175 
178  int FileType;
180  int DataType;
181 
183  size_t Alliquot;
185  size_t Count;
186 
189 
190 private:
191  vtkParticleReader(const vtkParticleReader&); // Not implemented.
192  void operator=(const vtkParticleReader&); // Not implemented.
193 };
194 
195 #endif
vtkIOGeometryModule.h
vtkParticleReader::SetDataByteOrder
void SetDataByteOrder(int)
vtkParticleReader::DetermineFileType
int DetermineFileType()
vtkParticleReader::DoProgressUpdate
void DoProgressUpdate(size_t &bytesRead, size_t &fileLength)
vtkParticleReader::SetDataByteOrderToLittleEndian
void SetDataByteOrderToLittleEndian()
vtkParticleReader::FILE_TYPE_IS_TEXT
@ FILE_TYPE_IS_TEXT
Definition: vtkParticleReader.h:172
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkParticleReader::GetDataByteOrder
int GetDataByteOrder()
vtkParticleReader::NumberOfPoints
size_t NumberOfPoints
Definition: vtkParticleReader.h:188
vtkParticleReader::OpenFile
void OpenFile()
vtkParticleReader::FileType
int FileType
Definition: vtkParticleReader.h:178
vtkParticleReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
VTKIOGEOMETRY_EXPORT
#define VTKIOGEOMETRY_EXPORT
Definition: vtkIOGeometryModule.h:15
vtkParticleReader::ProduceOutputFromTextFileFloat
int ProduceOutputFromTextFileFloat(vtkInformationVector *outputVector)
vtkParticleReader::GetSwapBytes
int GetSwapBytes()
Definition: vtkParticleReader.h:85
vtkParticleReader::~vtkParticleReader
~vtkParticleReader()
vtkPolyDataAlgorithm.h
vtkParticleReader::SetFileTypeToText
void SetFileTypeToText()
Definition: vtkParticleReader.h:104
vtkSetClampMacro
#define vtkSetClampMacro(name, type, min, max)
Definition: vtkSetGet.h:143
vtkParticleReader::ProduceOutputFromTextFileDouble
int ProduceOutputFromTextFileDouble(vtkInformationVector *outputVector)
vtkParticleReader::SwapBytes
int SwapBytes
Definition: vtkParticleReader.h:187
vtkParticleReader::SetDataTypeToFloat
void SetDataTypeToFloat()
Definition: vtkParticleReader.h:114
vtkParticleReader::File
ifstream * File
Definition: vtkParticleReader.h:126
vtkParticleReader::Alliquot
size_t Alliquot
Definition: vtkParticleReader.h:183
vtkParticleReader::FileName
char * FileName
Definition: vtkParticleReader.h:125
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSetStringMacro
#define vtkSetStringMacro(name)
Definition: vtkSetGet.h:104
VTK_FLOAT
#define VTK_FLOAT
Definition: vtkType.h:35
VTK_DOUBLE
#define VTK_DOUBLE
Definition: vtkType.h:36
vtkParticleReader::vtkParticleReader
vtkParticleReader()
vtkParticleReader::SetFileTypeToUnknown
void SetFileTypeToUnknown()
Definition: vtkParticleReader.h:103
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
vtkParticleReader
Read ASCII or binary particle data and (optionally) one scalar value associated with each particle.
Definition: vtkParticleReader.h:50
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkParticleReader::HasScalar
int HasScalar
Definition: vtkParticleReader.h:176
vtkParticleReader::SetDataByteOrderToBigEndian
void SetDataByteOrderToBigEndian()
vtkParticleReader::New
static vtkParticleReader * New()
vtkParticleReader::SetFileTypeToBinary
void SetFileTypeToBinary()
Definition: vtkParticleReader.h:105
vtkParticleReader::ProduceOutputFromBinaryFileFloat
int ProduceOutputFromBinaryFileFloat(vtkInformationVector *outputVector)
vtkParticleReader::SetDataTypeToDouble
void SetDataTypeToDouble()
Definition: vtkParticleReader.h:115
vtkParticleReader::DataType
int DataType
Definition: vtkParticleReader.h:180
vtkParticleReader::FILE_TYPE
FILE_TYPE
Definition: vtkParticleReader.h:171
vtkParticleReader::GetDataByteOrderAsString
const char * GetDataByteOrderAsString()
vtkParticleReader::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkParticleReader::ProduceOutputFromBinaryFileDouble
int ProduceOutputFromBinaryFileDouble(vtkInformationVector *outputVector)
vtkParticleReader::RequestInformation
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkParticleReader::Count
size_t Count
Definition: vtkParticleReader.h:185
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44