vtkParallelReader.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkParallelReader.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 vtkParallelReader_h
#define vtkParallelReader_h

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

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

struct vtkParallelReaderInternal;

class VTKCOMMONEXECUTIONMODEL_EXPORT vtkParallelReader : public vtkReaderAlgorithm
{
public:
  vtkTypeMacro(vtkParallelReader,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 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;

protected:
  vtkParallelReader();
  ~vtkParallelReader() override;

  vtkExecutive* CreateDefaultExecutive() override;

  virtual double GetTimeValue(const std::string& fname);

  virtual int ReadMesh(const std::string& fname,
                        int piece,
                        int npieces,
                        int nghosts,
                        vtkDataObject* output) = 0;

  virtual int ReadPoints(const std::string& fname,
                         int piece,
                         int npieces,
                         int nghosts,
                         vtkDataObject* output) = 0;

  virtual int ReadArrays(const std::string& fname,
                         int piece,
                         int npieces,
                         int nghosts,
                         vtkDataObject* output) = 0;

  int CurrentFileIndex;

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

  vtkParallelReaderInternal* Internal;
};

#endif