vtkXdmf3Reader.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 vtkXdmf3Reader_h
#define vtkXdmf3Reader_h
 
#include "vtkDataObjectAlgorithm.h"
#include "vtkIOXdmf3Module.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkXdmf3ArraySelection;
class vtkGraph;
 
class VTKIOXDMF3_EXPORT vtkXdmf3Reader : public vtkDataObjectAlgorithm
{
public:
  static vtkXdmf3Reader* New();
  vtkTypeMacro(vtkXdmf3Reader, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetFileName(VTK_FILEPATH const char* filename);
 
 
  virtual void AddFileName(VTK_FILEPATH const char* filename);
  virtual void RemoveAllFileNames();
 
 
  vtkSetMacro(FileSeriesAsTime, bool);
  vtkGetMacro(FileSeriesAsTime, bool);
 
  virtual int CanReadFile(VTK_FILEPATH const char* filename);
 
  int GetNumberOfPointArrays();
 
  const char* GetPointArrayName(int index);
 
 
  int GetPointArrayStatus(const char* name);
  void SetPointArrayStatus(const char* name, int status);
 
 
  int GetNumberOfCellArrays();
  const char* GetCellArrayName(int index);
  void SetCellArrayStatus(const char* name, int status);
  int GetCellArrayStatus(const char* name);
 
 
  int GetNumberOfFieldArrays();
  const char* GetFieldArrayName(int index);
  void SetFieldArrayStatus(const char* name, int status);
  int GetFieldArrayStatus(const char* name);
 
 
  int GetNumberOfGrids();
  const char* GetGridName(int index);
  void SetGridStatus(const char* gridname, int status);
  int GetGridStatus(const char* gridname);
 
 
  int GetNumberOfSets();
  const char* GetSetName(int index);
  void SetSetStatus(const char* gridname, int status);
  int GetSetStatus(const char* gridname);
 
  int GetNumberOfSetArrays() { return this->GetNumberOfSets(); }
  const char* GetSetArrayName(int index) { return this->GetSetName(index); }
  int GetSetArrayStatus(const char* name) { return this->GetSetStatus(name); }
 
  virtual vtkGraph* GetSIL();
 
  int GetSILUpdateStamp();
 
protected:
  vtkXdmf3Reader();
  ~vtkXdmf3Reader() override;
 
  const char* FileNameInternal;
  vtkSetFilePathMacro(FileNameInternal);
 
  // Overridden to announce that we make general DataObjects.
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  // Overridden to handle RDO requests the way we need to
  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  // Overridden to create the correct vtkDataObject subclass for the file.
  virtual int RequestDataObjectInternal(vtkInformationVector*);
 
  // Overridden to announce temporal information and to participate in
  // structured extent splitting.
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  // Read the XDMF and HDF input files and fill in vtk data objects.
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkXdmf3ArraySelection* GetFieldArraySelection();
  vtkXdmf3ArraySelection* GetCellArraySelection();
  vtkXdmf3ArraySelection* GetPointArraySelection();
  vtkXdmf3ArraySelection* GetGridsSelection();
  vtkXdmf3ArraySelection* GetSetsSelection();
  vtkXdmf3ArraySelection* FieldArraysCache;
  vtkXdmf3ArraySelection* CellArraysCache;
  vtkXdmf3ArraySelection* PointArraysCache;
  vtkXdmf3ArraySelection* GridsCache;
  vtkXdmf3ArraySelection* SetsCache;
 
private:
  vtkXdmf3Reader(const vtkXdmf3Reader&) = delete;
  void operator=(const vtkXdmf3Reader&) = delete;
 
  bool FileSeriesAsTime;
 
  class Internals;
  Internals* Internal;
};
 
VTK_ABI_NAMESPACE_END
#endif