vtkSimpleReader.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 vtkSimpleReader_h
#define vtkSimpleReader_h
 
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkReaderAlgorithm.h"
 
#include <string> // needed for std::string in the interface
 
VTK_ABI_NAMESPACE_BEGIN
struct vtkSimpleReaderInternal;
 
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSimpleReader : public vtkReaderAlgorithm
{
public:
  vtkTypeMacro(vtkSimpleReader, vtkReaderAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void AddFileName(VTK_FILEPATH const char* fname);
 
  void ClearFileNames();
 
  int GetNumberOfFileNames() const;
 
  VTK_FILEPATH const char* GetFileName(int i) const;
 
  VTK_FILEPATH const char* GetCurrentFileName() const;
 
 
  int ReadTimeDependentMetaData(int timestep, vtkInformation* metadata) override;
  int ReadMetaData(vtkInformation* metadata) override;
  int ReadMesh(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
  int ReadPoints(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
  int ReadArrays(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
 
  virtual double GetTimeValue(VTK_FILEPATH const std::string& fname);
 
  virtual int ReadMetaDataSimple(
    VTK_FILEPATH const std::string& /*fname*/, vtkInformation* /*metadata*/)
  {
    return 1;
  }
 
  virtual int ReadMeshSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
 
  virtual int ReadPointsSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
 
  virtual int ReadArraysSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
 
protected:
  vtkSimpleReader();
  ~vtkSimpleReader() override;
 
  int CurrentFileIndex;
  bool HasTemporalMetaData;
 
private:
  vtkSimpleReader(const vtkSimpleReader&) = delete;
  void operator=(const vtkSimpleReader&) = delete;
 
  vtkSimpleReaderInternal* Internal;
};
 
VTK_ABI_NAMESPACE_END
#endif