VTK
vtkGenericEnSightReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGenericEnSightReader.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 =========================================================================*/
26 #ifndef vtkGenericEnSightReader_h
27 #define vtkGenericEnSightReader_h
28 
29 #include "vtkIOEnSightModule.h" // For export macro
31 
32 class vtkCallbackCommand;
36 
37 class TranslationTableType;
38 
39 // Cell/Point Ids store mode:
40 // Sparse Mode is supposed to be for a large number of distributed processes (Unstructured)
41 // Non Sparse Mode is supposed to be for a small number of distributed processes (Unstructured)
42 // Implicit Mode is for Structured Data
44 {
49 };
50 
51 class VTKIOENSIGHT_EXPORT vtkGenericEnSightReader : public vtkMultiBlockDataSetAlgorithm
52 {
53 public:
56  void PrintSelf(ostream& os, vtkIndent indent);
57 
59 
62  void SetCaseFileName(const char* fileName);
63  vtkGetStringMacro(CaseFileName);
65 
67 
70  vtkSetStringMacro(FilePath);
71  vtkGetStringMacro(FilePath);
73 
75 
78  vtkGetMacro(EnSightVersion, int);
80 
82 
85  vtkGetMacro(NumberOfVariables, int);
86  vtkGetMacro(NumberOfComplexVariables, int);
88 
90 
93  int GetNumberOfVariables(int type); // returns -1 if unknown type specified
94  vtkGetMacro(NumberOfScalarsPerNode, int);
95  vtkGetMacro(NumberOfVectorsPerNode, int);
96  vtkGetMacro(NumberOfTensorsSymmPerNode, int);
97  vtkGetMacro(NumberOfScalarsPerElement, int);
98  vtkGetMacro(NumberOfVectorsPerElement, int);
99  vtkGetMacro(NumberOfTensorsSymmPerElement, int);
100  vtkGetMacro(NumberOfScalarsPerMeasuredNode, int);
101  vtkGetMacro(NumberOfVectorsPerMeasuredNode, int);
102  vtkGetMacro(NumberOfComplexScalarsPerNode, int);
103  vtkGetMacro(NumberOfComplexVectorsPerNode, int);
104  vtkGetMacro(NumberOfComplexScalarsPerElement, int);
105  vtkGetMacro(NumberOfComplexVectorsPerElement, int);
107 
111  const char* GetDescription(int n);
112 
116  const char* GetComplexDescription(int n);
117 
128  const char* GetDescription(int n, int type);
129 
131 
134  int GetVariableType(int n);
137 
139 
142  virtual void SetTimeValue(float value);
143  vtkGetMacro(TimeValue, float);
145 
147 
150  vtkGetMacro(MinimumTimeValue, float);
151  vtkGetMacro(MaximumTimeValue, float);
153 
155 
158  vtkGetObjectMacro(TimeSets, vtkDataArrayCollection);
160 
167  int DetermineEnSightVersion(int quiet=0);
168 
170 
173  vtkBooleanMacro(ReadAllVariables, int);
174  vtkSetMacro(ReadAllVariables, int);
175  vtkGetMacro(ReadAllVariables, int);
177 
179 
183  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
184  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
186 
188 
194 
196 
200  const char* GetPointArrayName(int index);
201  const char* GetCellArrayName(int index);
203 
205 
209  int GetPointArrayStatus(const char* name);
210  int GetCellArrayStatus(const char* name);
211  void SetPointArrayStatus(const char* name, int status);
212  void SetCellArrayStatus(const char* name, int status);
214 
216  {
217  ENSIGHT_6 = 0,
218  ENSIGHT_6_BINARY = 1,
219  ENSIGHT_GOLD = 2,
220  ENSIGHT_GOLD_BINARY = 3,
221  ENSIGHT_MASTER_SERVER = 4
222  };
223 
225 
233  vtkSetMacro(ByteOrder, int);
234  vtkGetMacro(ByteOrder, int);
235  const char *GetByteOrderAsString();
237 
238  enum
239  {
240  FILE_BIG_ENDIAN=0,
241  FILE_LITTLE_ENDIAN=1,
242  FILE_UNKNOWN_ENDIAN=2
243  };
244 
246 
250  vtkGetStringMacro(GeometryFileName);
252 
254 
266  vtkSetMacro(ParticleCoordinatesByIndex, int);
267  vtkGetMacro(ParticleCoordinatesByIndex, int);
268  vtkBooleanMacro(ParticleCoordinatesByIndex, int);
270 
275  static int CanReadFile(const char *casefilename);
276 
277 //THIB
278 vtkGenericEnSightReader* GetReader() { return this->Reader; }
279 
280 
281 protected:
284 
292 
298  virtual void ClearForNewCaseFileName();
299 
304  int ReadLine(char result[256]);
305 
310  int ReadBinaryLine(char result[80]);
311 
312  // Internal function that skips blank lines and reads the 1st
313  // non-blank line it finds (up to 256 characters).
314  // Returns 0 is there was an error.
315  int ReadNextDataLine(char result[256]);
316 
318 
321  vtkSetStringMacro(GeometryFileName);
323 
325 
331 
333 
336  void AddVariableType(int variableType);
337  void AddComplexVariableType(int variableType);
339 
341 
345  int ReplaceWildcards(char* fileName, int timeSet, int fileSet);
346  void ReplaceWildcardsHelper(char* fileName, int num);
348 
349  // Callback registered with the SelectionObserver.
350  static void SelectionModifiedCallback(vtkObject* caller, unsigned long eid,
351  void* clientdata, void* calldata);
353 
354  // Utility to create argument for vtkDataArraySelection::SetArrays.
355  char** CreateStringArray(int numStrings);
356  void DestroyStringArray(int numStrings, char** strings);
357 
358  // Fill the vtkDataArraySelection objects with the current set of
359  // EnSight variables.
361 
362  // Fill the vtkDataArraySelection objects with the current set of
363  // arrays in the internal EnSight reader.
365 
366  // Fill the internal EnSight reader's vtkDataArraySelection objects
367  // from those in this object.
369 
370  istream* IS;
371  FILE *IFile;
373 
376  char* FilePath;
377 
378  // array of types (one entry per instance of variable type in case file)
381 
382  // pointers to lists of descriptions
385 
388 
389  // number of file names / descriptions per type
402 
403  float TimeValue;
406 
407  // Flag for whether TimeValue has been set.
409 
412 
414 
417 
418  // The EnSight file version being read. Valid after
419  // UpdateInformation. Value is -1 for unknown version.
421 
422  // The array selections. These map over the variables and complex
423  // variables to hide the details of EnSight behind VTK terminology.
426 
427  // The observer to modify this object when the array selections are
428  // modified.
430 
431  // Whether the SelectionModified callback should invoke Modified.
432  // This is used when we are copying to/from the internal reader.
434 
435  // Insert a partId and return the 'realId' that should be used.
436  int InsertNewPartId(int partId);
437 
438  // Wrapper around an stl map
439  TranslationTableType *TranslationTable;
440 
441 private:
442  vtkGenericEnSightReader(const vtkGenericEnSightReader&) VTK_DELETE_FUNCTION;
443  void operator=(const vtkGenericEnSightReader&) VTK_DELETE_FUNCTION;
444 };
445 
446 #endif
SINGLE_PROCESS_MODE
@ SINGLE_PROCESS_MODE
Definition: vtkGenericEnSightReader.h:45
vtkGenericEnSightReader::MaximumTimeValue
float MaximumTimeValue
Definition: vtkGenericEnSightReader.h:405
vtkGenericEnSightReader::TimeValue
float TimeValue
Definition: vtkGenericEnSightReader.h:403
vtkGenericEnSightReader::ReadLine
int ReadLine(char result[256])
Internal function to read in a line up to 256 characters.
vtkGenericEnSightReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkGenericEnSightReader::CanReadFile
static int CanReadFile(const char *casefilename)
Returns true if the file pointed to by casefilename appears to be a valid EnSight case file.
vtkGenericEnSightReader::GetNumberOfPointArrays
int GetNumberOfPointArrays()
Get the number of point or cell arrays available in the input.
vtkGenericEnSightReader::NumberOfVectorsPerNode
int NumberOfVectorsPerNode
Definition: vtkGenericEnSightReader.h:391
vtkGenericEnSightReader::~vtkGenericEnSightReader
~vtkGenericEnSightReader()
vtkGenericEnSightReader::AddVariableType
void AddVariableType(int variableType)
Add a variable type to the appropriate array.
vtkGenericEnSightReader::GetNumberOfVariables
int GetNumberOfVariables(int type)
Get the number of variables of a particular type.
vtkGenericEnSightReader::GetVariableType
int GetVariableType(int n)
Get the variable type of variable n.
vtkGenericEnSightReader::GetPointArrayName
const char * GetPointArrayName(int index)
Get the name of the point or cell array with the given index in the input.
vtkGenericEnSightReader::SetTimeValue
virtual void SetTimeValue(float value)
Set/Get the time value at which to get the value.
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkX3D::type
@ type
Definition: vtkX3D.h:516
vtkGenericEnSightReader::AddComplexVariableDescription
void AddComplexVariableDescription(const char *description)
vtkGenericEnSightReader::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
vtkGenericEnSightReader::NumberOfScalarsPerElement
int NumberOfScalarsPerElement
Definition: vtkGenericEnSightReader.h:393
vtkGenericEnSightReader::TimeSets
vtkDataArrayCollection * TimeSets
Definition: vtkGenericEnSightReader.h:410
vtkGenericEnSightReader::GeometryFileName
char * GeometryFileName
Definition: vtkGenericEnSightReader.h:375
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkGenericEnSightReader::MinimumTimeValue
float MinimumTimeValue
Definition: vtkGenericEnSightReader.h:404
vtkGenericEnSightReader::NumberOfTensorsSymmPerNode
int NumberOfTensorsSymmPerNode
Definition: vtkGenericEnSightReader.h:392
vtkDataArrayCollection
maintain an unordered list of dataarray objects
Definition: vtkDataArrayCollection.h:35
vtkGenericEnSightReader::TimeValueInitialized
int TimeValueInitialized
Definition: vtkGenericEnSightReader.h:408
vtkGenericEnSightReader::DestroyStringArray
void DestroyStringArray(int numStrings, char **strings)
IMPLICIT_STRUCTURED_MODE
@ IMPLICIT_STRUCTURED_MODE
Definition: vtkGenericEnSightReader.h:48
vtkGenericEnSightReader::SelectionObserver
vtkCallbackCommand * SelectionObserver
Definition: vtkGenericEnSightReader.h:429
vtkGenericEnSightReader::GetDescription
const char * GetDescription(int n)
Get the nth description for a non-complex variable.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkGenericEnSightReader::DetermineEnSightVersion
int DetermineEnSightVersion(int quiet=0)
Reads the FORMAT part of the case file to determine whether this is an EnSight6 or EnSightGold data s...
vtkGenericEnSightReader::NumberOfVectorsPerMeasuredNode
int NumberOfVectorsPerMeasuredNode
Definition: vtkGenericEnSightReader.h:397
vtkGenericEnSightReader::GetNumberOfCellArrays
int GetNumberOfCellArrays()
vtkGenericEnSightReader::GetPointArrayStatus
int GetPointArrayStatus(const char *name)
Get/Set whether the point or cell array with the given name is to be read.
vtkGenericEnSightReader::NumberOfScalarsPerMeasuredNode
int NumberOfScalarsPerMeasuredNode
Definition: vtkGenericEnSightReader.h:396
vtkGenericEnSightReader::CreateStringArray
char ** CreateStringArray(int numStrings)
vtkGenericEnSightReader::VariableTypes
int * VariableTypes
Definition: vtkGenericEnSightReader.h:379
vtkGenericEnSightReader::NumberOfTensorsSymmPerElement
int NumberOfTensorsSymmPerElement
Definition: vtkGenericEnSightReader.h:395
vtkGenericEnSightReader::SelectionModified
void SelectionModified()
vtkGenericEnSightReader::InsertNewPartId
int InsertNewPartId(int partId)
vtkGenericEnSightReader::ReadAllVariables
int ReadAllVariables
Definition: vtkGenericEnSightReader.h:413
vtkGenericEnSightReader::IS
istream * IS
Definition: vtkGenericEnSightReader.h:370
vtkDataArraySelection
Store on/off settings for data arrays for a vtkSource.
Definition: vtkDataArraySelection.h:35
vtkGenericEnSightReader::ComplexVariableTypes
int * ComplexVariableTypes
Definition: vtkGenericEnSightReader.h:380
vtkGenericEnSightReader::NumberOfComplexVariables
int NumberOfComplexVariables
Definition: vtkGenericEnSightReader.h:387
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkGenericEnSightReader::NumberOfComplexScalarsPerElement
int NumberOfComplexScalarsPerElement
Definition: vtkGenericEnSightReader.h:400
vtkGenericEnSightReader::SetByteOrderToLittleEndian
void SetByteOrderToLittleEndian()
vtkGenericEnSightReader::NumberOfScalarsPerNode
int NumberOfScalarsPerNode
Definition: vtkGenericEnSightReader.h:390
vtkGenericEnSightReader::FileTypes
FileTypes
Definition: vtkGenericEnSightReader.h:216
vtkGenericEnSightReader::NumberOfVectorsPerElement
int NumberOfVectorsPerElement
Definition: vtkGenericEnSightReader.h:394
vtkGenericEnSightReader::SetReaderDataArraySelectionSetsFromSelf
void SetReaderDataArraySelectionSetsFromSelf()
vtkGenericEnSightReader::TranslationTable
TranslationTableType * TranslationTable
Definition: vtkGenericEnSightReader.h:439
vtkGenericEnSightReader::SelectionModifiedCallback
static void SelectionModifiedCallback(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
vtkGenericEnSightReader::SetPointArrayStatus
void SetPointArrayStatus(const char *name, int status)
vtkGenericEnSightReader::GetDescription
const char * GetDescription(int n, int type)
Get the nth description of a particular variable type.
vtkGenericEnSightReader::ReplaceWildcardsHelper
void ReplaceWildcardsHelper(char *fileName, int num)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGenericEnSightReader
class to read any type of EnSight files
Definition: vtkGenericEnSightReader.h:52
vtkGenericEnSightReader::PointDataArraySelection
vtkDataArraySelection * PointDataArraySelection
Definition: vtkGenericEnSightReader.h:424
vtkGenericEnSightReader::ByteOrder
int ByteOrder
Definition: vtkGenericEnSightReader.h:415
vtkGenericEnSightReader::ComplexVariableDescriptions
char ** ComplexVariableDescriptions
Definition: vtkGenericEnSightReader.h:384
vtkMultiBlockDataSetAlgorithm.h
SPARSE_MODE
@ SPARSE_MODE
Definition: vtkGenericEnSightReader.h:46
vtkIdListCollection
maintain an unordered list of dataarray objects
Definition: vtkIdListCollection.h:35
NON_SPARSE_MODE
@ NON_SPARSE_MODE
Definition: vtkGenericEnSightReader.h:47
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkGenericEnSightReader::ClearForNewCaseFileName
virtual void ClearForNewCaseFileName()
Clear data structures such that setting a new case file name works.
vtkGenericEnSightReader::NumberOfComplexScalarsPerNode
int NumberOfComplexScalarsPerNode
Definition: vtkGenericEnSightReader.h:398
vtkGenericEnSightReader::Reader
vtkGenericEnSightReader * Reader
Definition: vtkGenericEnSightReader.h:372
vtkGenericEnSightReader::FilePath
char * FilePath
Definition: vtkGenericEnSightReader.h:376
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkGenericEnSightReader::SetCellArrayStatus
void SetCellArrayStatus(const char *name, int status)
vtkGenericEnSightReader::ReplaceWildcards
int ReplaceWildcards(char *fileName, int timeSet, int fileSet)
Replace the wildcards in the geometry file name with appropriate filename numbers as specified in the...
vtkGenericEnSightReader::NumberOfVariables
int NumberOfVariables
Definition: vtkGenericEnSightReader.h:386
vtkGenericEnSightReader::SelectionModifiedDoNotCallModified
int SelectionModifiedDoNotCallModified
Definition: vtkGenericEnSightReader.h:433
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkGenericEnSightReader::FillOutputPortInformation
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
vtkGenericEnSightReader::CellDataArraySelection
vtkDataArraySelection * CellDataArraySelection
Definition: vtkGenericEnSightReader.h:425
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkGenericEnSightReader::VariableDescriptions
char ** VariableDescriptions
Definition: vtkGenericEnSightReader.h:383
vtkGenericEnSightReader::SetCaseFileName
void SetCaseFileName(const char *fileName)
Set/Get the Case file name.
vtkGenericEnSightReader::GetCellArrayStatus
int GetCellArrayStatus(const char *name)
vtkGenericEnSightReader::GetByteOrderAsString
const char * GetByteOrderAsString()
vtkGenericEnSightReader::SetDataArraySelectionSetsFromVariables
void SetDataArraySelectionSetsFromVariables()
vtkX3D::description
@ description
Definition: vtkX3D.h:322
vtkGenericEnSightReader::SetByteOrderToBigEndian
void SetByteOrderToBigEndian()
Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write l...
vtkGenericEnSightReader::GetReader
vtkGenericEnSightReader * GetReader()
Definition: vtkGenericEnSightReader.h:278
vtkGenericEnSightReader::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
vtkCallbackCommand
supports function callbacks
Definition: vtkCallbackCommand.h:51
vtkGenericEnSightReader::SetDataArraySelectionSetsFromReader
void SetDataArraySelectionSetsFromReader()
vtkGenericEnSightReader::ReadNextDataLine
int ReadNextDataLine(char result[256])
vtkGenericEnSightReader::New
static vtkGenericEnSightReader * New()
vtkGenericEnSightReader::CaseFileName
char * CaseFileName
Definition: vtkGenericEnSightReader.h:374
vtkGenericEnSightReader::GetCellArrayName
const char * GetCellArrayName(int index)
vtkGenericEnSightReader::EnSightVersion
int EnSightVersion
Definition: vtkGenericEnSightReader.h:420
vtkGenericEnSightReader::GetComplexDescription
const char * GetComplexDescription(int n)
Get the nth description for a complex variable.
vtkGenericEnSightReader::NumberOfComplexVectorsPerNode
int NumberOfComplexVectorsPerNode
Definition: vtkGenericEnSightReader.h:399
EnsightReaderCellIdMode
EnsightReaderCellIdMode
Definition: vtkGenericEnSightReader.h:44
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkGenericEnSightReader::GetComplexVariableType
int GetComplexVariableType(int n)
vtkGenericEnSightReader::vtkGenericEnSightReader
vtkGenericEnSightReader()
vtkGenericEnSightReader::SetTimeSets
virtual void SetTimeSets(vtkDataArrayCollection *)
vtkGenericEnSightReader::IFile
FILE * IFile
Definition: vtkGenericEnSightReader.h:371
vtkGenericEnSightReader::AddComplexVariableType
void AddComplexVariableType(int variableType)
vtkGenericEnSightReader::ReadBinaryLine
int ReadBinaryLine(char result[80])
Internal function to read up to 80 characters from a binary file.
vtkGenericEnSightReader::AddVariableDescription
void AddVariableDescription(const char *description)
Add a variable description to the appropriate array.
vtkGenericEnSightReader::NumberOfComplexVectorsPerElement
int NumberOfComplexVectorsPerElement
Definition: vtkGenericEnSightReader.h:401
vtkGenericEnSightReader::ParticleCoordinatesByIndex
int ParticleCoordinatesByIndex
Definition: vtkGenericEnSightReader.h:416
vtkMultiBlockDataSetAlgorithm
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
Definition: vtkMultiBlockDataSetAlgorithm.h:33