vtkSimpleReader.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkSimpleReader.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.

=========================================================================*/
#ifndef vtkSimpleReader_h
#define vtkSimpleReader_h

#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkReaderAlgorithm.h"

#include <string> // needed for std::string in the interface

struct vtkSimpleReaderInternal;

class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSimpleReader : public vtkReaderAlgorithm
{
public:
  vtkTypeMacro(vtkSimpleReader,vtkReaderAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void AddFileName(const char* fname);

  void ClearFileNames();

  int GetNumberOfFileNames() const;

  const char* GetFileName(int i) const;

  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(const std::string& fname);

  virtual int ReadMetaDataSimple(const std::string& /*fname*/,
                                 vtkInformation* /*metadata*/)
  {
    return 1;
  }

  virtual int ReadMeshSimple(const std::string& fname,
                             vtkDataObject* output) = 0;

  virtual int ReadPointsSimple(const std::string& fname,
                               vtkDataObject* output) = 0;

  virtual int ReadArraysSimple(const std::string& fname,
                               vtkDataObject* output) = 0;

protected:
  vtkSimpleReader();
  ~vtkSimpleReader() override;

  vtkExecutive* CreateDefaultExecutive() override;


  int CurrentFileIndex;
  bool HasTemporalMetaData;

private:
  vtkSimpleReader(const vtkSimpleReader&) = delete;
  void operator=(const vtkSimpleReader&) = delete;

  vtkSimpleReaderInternal* Internal;
};

#endif