/usr/include/vtk-5.8/vtkGenericEnSightReader.h is in libvtk5-dev 5.8.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | /*=========================================================================
Program: Visualization Toolkit
Module: vtkGenericEnSightReader.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkGenericEnSightReader - class to read any type of EnSight files
// .SECTION Description
// The class vtkGenericEnSightReader allows the user to read an EnSight data
// set without a priori knowledge of what type of EnSight data set it is.
#ifndef __vtkGenericEnSightReader_h
#define __vtkGenericEnSightReader_h
#include "vtkMultiBlockDataSetAlgorithm.h"
class vtkCallbackCommand;
class vtkDataArrayCollection;
class vtkDataArraySelection;
class vtkIdListCollection;
//BTX
class TranslationTableType;
//ETX
//BTX
// Cell/Point Ids store mode:
// Sparse Mode is supposed to be for a large number of distributed processes (Unstructured)
// Non Sparse Mode is supposed to be for a small number of distributed processes (Unstructured)
// Implicit Mode is for Structured Data
enum EnsightReaderCellIdMode
{
SINGLE_PROCESS_MODE,
SPARSE_MODE,
NON_SPARSE_MODE,
IMPLICIT_STRUCTURED_MODE
};
//ETX
class VTK_IO_EXPORT vtkGenericEnSightReader : public vtkMultiBlockDataSetAlgorithm
{
public:
static vtkGenericEnSightReader *New();
vtkTypeMacro(vtkGenericEnSightReader, vtkMultiBlockDataSetAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Set/Get the Case file name.
void SetCaseFileName(const char* fileName);
vtkGetStringMacro(CaseFileName);
// Description:
// Set/Get the file path.
vtkSetStringMacro(FilePath);
vtkGetStringMacro(FilePath);
// Description:
// Get the EnSight file version being read.
vtkGetMacro(EnSightVersion, int);
// Description:
// Get the number of variables listed in the case file.
vtkGetMacro(NumberOfVariables, int);
vtkGetMacro(NumberOfComplexVariables, int);
// Description:
// Get the number of variables of a particular type.
int GetNumberOfVariables(int type); // returns -1 if unknown type specified
vtkGetMacro(NumberOfScalarsPerNode, int);
vtkGetMacro(NumberOfVectorsPerNode, int);
vtkGetMacro(NumberOfTensorsSymmPerNode, int);
vtkGetMacro(NumberOfScalarsPerElement, int);
vtkGetMacro(NumberOfVectorsPerElement, int);
vtkGetMacro(NumberOfTensorsSymmPerElement, int);
vtkGetMacro(NumberOfScalarsPerMeasuredNode, int);
vtkGetMacro(NumberOfVectorsPerMeasuredNode, int);
vtkGetMacro(NumberOfComplexScalarsPerNode, int);
vtkGetMacro(NumberOfComplexVectorsPerNode, int);
vtkGetMacro(NumberOfComplexScalarsPerElement, int);
vtkGetMacro(NumberOfComplexVectorsPerElement, int);
// Description:
// Get the nth description for a non-complex variable.
const char* GetDescription(int n);
// Description:
// Get the nth description for a complex variable.
const char* GetComplexDescription(int n);
// Description:
// Get the nth description of a particular variable type. Returns NULL if no
// variable of this type exists in this data set.
// SCALAR_PER_NODE = 0; VECTOR_PER_NODE = 1;
// TENSOR_SYMM_PER_NODE = 2; SCALAR_PER_ELEMENT = 3;
// VECTOR_PER_ELEMENT = 4; TENSOR_SYMM_PER_ELEMENT = 5;
// SCALAR_PER_MEASURED_NODE = 6; VECTOR_PER_MEASURED_NODE = 7;
// COMPLEX_SCALAR_PER_NODE = 8; COMPLEX_VECTOR_PER_NODE 9;
// COMPLEX_SCALAR_PER_ELEMENT = 10; COMPLEX_VECTOR_PER_ELEMENT = 11
const char* GetDescription(int n, int type);
// Description:
// Get the variable type of variable n.
int GetVariableType(int n);
int GetComplexVariableType(int n);
// Description:
// Set/Get the time value at which to get the value.
virtual void SetTimeValue(float value);
vtkGetMacro(TimeValue, float);
// Description:
// Get the minimum or maximum time value for this data set.
vtkGetMacro(MinimumTimeValue, float);
vtkGetMacro(MaximumTimeValue, float);
// Description:
// Get the time values per time set
vtkGetObjectMacro(TimeSets, vtkDataArrayCollection);
// Description:
// Reads the FORMAT part of the case file to determine whether this is an
// EnSight6 or EnSightGold data set. Returns an identifier listed in
// the FileTypes enum or -1 if an error occurred or the file could not
// be indentified as any EnSight type.
int DetermineEnSightVersion(int quiet=0);
// Description:
// Set/get the flag for whether to read all the variables
vtkBooleanMacro(ReadAllVariables, int);
vtkSetMacro(ReadAllVariables, int);
vtkGetMacro(ReadAllVariables, int);
// Description:
// Get the data array selection tables used to configure which data
// arrays are loaded by the reader.
vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
// Description:
// Get the number of point or cell arrays available in the input.
int GetNumberOfPointArrays();
int GetNumberOfCellArrays();
// Description:
// Get the name of the point or cell array with the given index in
// the input.
const char* GetPointArrayName(int index);
const char* GetCellArrayName(int index);
// Description:
// Get/Set whether the point or cell array with the given name is to
// be read.
int GetPointArrayStatus(const char* name);
int GetCellArrayStatus(const char* name);
void SetPointArrayStatus(const char* name, int status);
void SetCellArrayStatus(const char* name, int status);
//BTX
enum FileTypes
{
ENSIGHT_6 = 0,
ENSIGHT_6_BINARY = 1,
ENSIGHT_GOLD = 2,
ENSIGHT_GOLD_BINARY = 3,
ENSIGHT_MASTER_SERVER = 4
};
//ETX
// Description:
// Set the byte order of the file (remember, more Unix workstations
// write big endian whereas PCs write little endian). Default is
// big endian (since most older PLOT3D files were written by
// workstations).
void SetByteOrderToBigEndian();
void SetByteOrderToLittleEndian();
vtkSetMacro(ByteOrder, int);
vtkGetMacro(ByteOrder, int);
const char *GetByteOrderAsString();
//BTX
enum
{
FILE_BIG_ENDIAN=0,
FILE_LITTLE_ENDIAN=1,
FILE_UNKNOWN_ENDIAN=2
};
//ETX
// Description:
// Get the Geometry file name. Made public to allow access from
// apps requiring detailed info about the Data contents
vtkGetStringMacro(GeometryFileName);
// Description:
// The MeasuredGeometryFile should list particle coordinates
// from 0->N-1.
// If a file is loaded where point Ids are listed from 1-N
// the Id to points reference will be wrong and the data
// will be generated incorrectly.
// Setting ParticleCoordinatesByIndex to true will force
// all Id's to increment from 0->N-1 (relative to their order
// in the file) and regardless of the actual Id of of the point.
// Warning, if the Points are listed in non sequential order
// then setting this flag will reorder them.
vtkSetMacro(ParticleCoordinatesByIndex, int);
vtkGetMacro(ParticleCoordinatesByIndex, int);
vtkBooleanMacro(ParticleCoordinatesByIndex, int);
// Description:
// Returns true if the file pointed to by casefilename appears to be a
// valid EnSight case file.
static int CanReadFile(const char *casefilename);
//THIB
vtkGenericEnSightReader* GetReader() { return this->Reader; }
protected:
vtkGenericEnSightReader();
~vtkGenericEnSightReader();
virtual int FillOutputPortInformation(int port, vtkInformation* info);
virtual int RequestInformation(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
virtual int RequestData(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// Internal function to read in a line up to 256 characters.
// Returns zero if there was an error.
int ReadLine(char result[256]);
// Description:
// Internal function to read up to 80 characters from a binary file.
// Returns zero if there was an error.
int ReadBinaryLine(char result[80]);
// Internal function that skips blank lines and reads the 1st
// non-blank line it finds (up to 256 characters).
// Returns 0 is there was an error.
int ReadNextDataLine(char result[256]);
// Description:
// Set the geometry file name.
vtkSetStringMacro(GeometryFileName);
// Description:
// Add a variable description to the appropriate array.
void AddVariableDescription(const char* description);
void AddComplexVariableDescription(const char* description);
// Description:
// Add a variable type to the appropriate array.
void AddVariableType(int variableType);
void AddComplexVariableType(int variableType);
// Description:
// Replace the wildcards in the geometry file name with appropriate filename
// numbers as specified in the time set or file set.
int ReplaceWildcards(char* fileName, int timeSet, int fileSet);
void ReplaceWildcardsHelper(char* fileName, int num);
// Callback registered with the SelectionObserver.
static void SelectionModifiedCallback(vtkObject* caller, unsigned long eid,
void* clientdata, void* calldata);
void SelectionModified();
// Utility to create argument for vtkDataArraySelection::SetArrays.
char** CreateStringArray(int numStrings);
void DestroyStringArray(int numStrings, char** strings);
// Fill the vtkDataArraySelection objects with the current set of
// EnSight variables.
void SetDataArraySelectionSetsFromVariables();
// Fill the vtkDataArraySelection objects with the current set of
// arrays in the internal EnSight reader.
void SetDataArraySelectionSetsFromReader();
// Fill the internal EnSight reader's vtkDataArraySelection objects
// from those in this object.
void SetReaderDataArraySelectionSetsFromSelf();
istream* IS;
FILE *IFile;
vtkGenericEnSightReader *Reader;
char* CaseFileName;
char* GeometryFileName;
char* FilePath;
// array of types (one entry per instance of variable type in case file)
int* VariableTypes;
int* ComplexVariableTypes;
// pointers to lists of descriptions
char** VariableDescriptions;
char** ComplexVariableDescriptions;
int NumberOfVariables;
int NumberOfComplexVariables;
// number of file names / descriptions per type
int NumberOfScalarsPerNode;
int NumberOfVectorsPerNode;
int NumberOfTensorsSymmPerNode;
int NumberOfScalarsPerElement;
int NumberOfVectorsPerElement;
int NumberOfTensorsSymmPerElement;
int NumberOfScalarsPerMeasuredNode;
int NumberOfVectorsPerMeasuredNode;
int NumberOfComplexScalarsPerNode;
int NumberOfComplexVectorsPerNode;
int NumberOfComplexScalarsPerElement;
int NumberOfComplexVectorsPerElement;
float TimeValue;
float MinimumTimeValue;
float MaximumTimeValue;
// Flag for whether TimeValue has been set.
int TimeValueInitialized;
vtkDataArrayCollection *TimeSets;
virtual void SetTimeSets(vtkDataArrayCollection*);
int ReadAllVariables;
int ByteOrder;
int ParticleCoordinatesByIndex;
// The EnSight file version being read. Valid after
// UpdateInformation. Value is -1 for unknown version.
int EnSightVersion;
// The array selections. These map over the variables and complex
// variables to hide the details of EnSight behind VTK terminology.
vtkDataArraySelection* PointDataArraySelection;
vtkDataArraySelection* CellDataArraySelection;
// The observer to modify this object when the array selections are
// modified.
vtkCallbackCommand* SelectionObserver;
// Whether the SelectionModified callback should invoke Modified.
// This is used when we are copying to/from the internal reader.
int SelectionModifiedDoNotCallModified;
// Insert a partId and return the 'realId' that should be used.
int InsertNewPartId(int partId);
// Wrapper around an stl map
TranslationTableType *TranslationTable;
private:
vtkGenericEnSightReader(const vtkGenericEnSightReader&); // Not implemented.
void operator=(const vtkGenericEnSightReader&); // Not implemented.
};
#endif
|