vtkEnSightGoldBinaryReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkEnSightGoldBinaryReader_h
#define vtkEnSightGoldBinaryReader_h
 
#include "vtkEnSightReader.h"
#include "vtkIOEnSightModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMultiBlockDataSet;
 
class VTKIOENSIGHT_EXPORT vtkEnSightGoldBinaryReader : public vtkEnSightReader
{
public:
  static vtkEnSightGoldBinaryReader* New();
  vtkTypeMacro(vtkEnSightGoldBinaryReader, vtkEnSightReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
protected:
  vtkEnSightGoldBinaryReader();
  ~vtkEnSightGoldBinaryReader() override;
 
  // Returns 1 if successful.  Sets file size as a side action.
  int OpenFile(const char* filename);
 
  // Returns 1 if successful.  Handles constructing the filename, opening the file and checking
  // if it's binary
  int InitializeFile(const char* filename);
 
  int ReadGeometryFile(const char* fileName, int timeStep, vtkMultiBlockDataSet* output) override;
 
  int ReadMeasuredGeometryFile(
    const char* fileName, int timeStep, vtkMultiBlockDataSet* output) override;
 
  int ReadScalarsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int measured = 0, int numberOfComponents = 1,
    int component = 0) override;
 
  int ReadVectorsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int measured = 0) override;
 
  int ReadAsymmetricTensorsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output) override;
 
  int ReadTensorsPerNode(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output) override;
 
  int ReadScalarsPerElement(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output, int numberOfComponents = 1, int component = 0) override;
 
  int ReadVectorsPerElement(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output) override;
 
  int ReadAsymmetricTensorsPerElement(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output) override;
 
  int ReadTensorsPerElement(const char* fileName, const char* description, int timeStep,
    vtkMultiBlockDataSet* output) override;
 
  int CreateUnstructuredGridOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output) override;
 
  int CreateStructuredGridOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output) override;
 
  int CreateRectilinearGridOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output);
 
  int CreateImageDataOutput(
    int partId, char line[80], const char* name, vtkMultiBlockDataSet* output);
 
  int ReadLine(char result[80]);
 
 
  int ReadInt(int* result);
  int ReadPartId(int* result);
 
  int ReadFloat(float* result);
 
  int ReadIntArray(int* result, int numInts);
 
  int ReadLong(vtkTypeInt64* result);
 
  int ReadFloatArray(float* result, int numFloats);
 
  int CountTimeSteps();
 
 
  int SkipTimeStep();
  int SkipStructuredGrid(char line[256]);
  int SkipUnstructuredGrid(char line[256]);
  int SkipRectilinearGrid(char line[256]);
  int SkipImageData(char line[256]);
 
  int SeekToCachedTimeStep(const char* fileName, int realTimeStep);
 
  void AddTimeStepToCache(const char* fileName, int realTimeStep, vtkTypeInt64 address);
 
  void AddFileIndexToCache(const char* fileName);
 
  int NodeIdsListed;
  int ElementIdsListed;
  int Fortran;
  int FortranSkipBytes; // Number of bytes to skip when seeking within a fortran-written file
 
  istream* GoldIFile;
  // The size of the file could be used to choose byte order.
  vtkTypeUInt64 FileSize;
 
  class FileOffsetMapInternal;
  FileOffsetMapInternal* FileOffsets;
 
private:
  int SizeOfInt;
  vtkEnSightGoldBinaryReader(const vtkEnSightGoldBinaryReader&) = delete;
  void operator=(const vtkEnSightGoldBinaryReader&) = delete;
 
  bool OpenVariableFile(const char* fname, const char* variableType);
 
  bool SkipToTimeStep(const char* fileName, int timeStep, vtkMultiBlockDataSet* compositeOutput,
    int attributeType, int numComponents, bool measured);
 
  bool ReadMeasureVariableArray(
    const char* description, vtkMultiBlockDataSet* compositeOutput, int numComponents);
 
  bool ReadVariableArray(const char* description, vtkMultiBlockDataSet* compositeOutput,
    int attributeType, int numComponents, int component = -1);
 
  class vtkUtilities;
  friend class vtkUtilities;
};
 
VTK_ABI_NAMESPACE_END
#endif