vtkFidesReader.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 vtkFidesReader_h
#define vtkFidesReader_h
 
#include "vtkAlgorithm.h"
#include "vtkIOFidesModule.h" // For export macro
#include <memory>             // for std::unique_ptr
#include <string>             // for std::string
 
#ifdef __VTK_WRAP__
#define vtkPyObjectFwd PyObject
#else
struct _object;
#define vtkPyObjectFwd _object
#endif
 
// Forward declare the Conduit C-API opaque pointer type exactly as
// Conduit does to avoid struct vs typedef collisions in C++.
struct conduit_node_impl;
typedef struct conduit_node_impl conduit_node;
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArraySelection;
class vtkMultiProcessController;
class vtkStringArray;
 
class VTKIOFIDES_EXPORT vtkFidesReader : public vtkAlgorithm
{
public:
  enum StepStatus
  {
    OK,
    NotReady,
    EndOfStream
  };
 
  vtkTypeMacro(vtkFidesReader, vtkAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkFidesReader* New();

  int CanReadFile(VTK_FILEPATH const std::string& name);

  void SetFileName(VTK_FILEPATH const std::string& fname);


  void ParseDataModel(VTK_FILEPATH const std::string& fname);
  void ParseDataModel();

  void SetSchema(const std::string& jsonText);

  vtkStringArray* GetDataSourceNames();

  void SetDataSourcePath(const std::string& name, VTK_FILEPATH const std::string& path);

  void SetDataSourceEngine(const std::string& name, const std::string& engine);

  void SetDataSourceIO(const std::string& name, const std::string& ioAddress);

  bool SetDataSourceNode(const std::string& name, conduit_node* node);

  bool SetDataSourceNode(const std::string& name, vtkPyObjectFwd* conduitNode);

  void RemoveDataSourceNode(const std::string& name);

  void RemoveAllDataSourceNodes();

  int ProcessRequest(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  void PrepareNextStep();

  int GetNextStepStatus();

  void SetTimeValue(double t);

  double GetTimeOfCurrentStep();


  vtkBooleanMacro(StreamSteps, bool);
  vtkSetMacro(StreamSteps, bool);
  vtkGetMacro(StreamSteps, bool);


  vtkBooleanMacro(CreateSharedPoints, bool);
  vtkSetMacro(CreateSharedPoints, bool);
  vtkGetMacro(CreateSharedPoints, bool);

  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);

  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);

  vtkGetObjectMacro(FieldDataArraySelection, vtkDataArraySelection);


  int GetNumberOfPointArrays();
  int GetNumberOfCellArrays();
  int GetNumberOfFieldArrays();


  const char* GetPointArrayName(int index);
  const char* GetCellArrayName(int index);
  const char* GetFieldArrayName(int index);


  int GetPointArrayStatus(const char* name);
  int GetCellArrayStatus(const char* name);
  int GetFieldArrayStatus(const char* name);
  void SetPointArrayStatus(const char* name, int status);
  void SetCellArrayStatus(const char* name, int status);
  void SetFieldArrayStatus(const char* name, int status);

  vtkGetObjectMacro(CellGridAttributeArraySelection, vtkDataArraySelection);


  int GetNumberOfCellGridAttributeArrays();
  const char* GetCellGridAttributeArrayName(int index);
  int GetCellGridAttributeArrayStatus(const char* name);
  void SetCellGridAttributeArrayStatus(const char* name, int status);

  vtkMTimeType GetMTime() override;


  virtual void SetController(vtkMultiProcessController* controller);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
protected:
  vtkFidesReader();
  ~vtkFidesReader() override;
 
  struct vtkFidesReaderImpl;
  std::unique_ptr<vtkFidesReaderImpl> Impl;
 
  std::string FileName;
  std::string SchemaString;
  bool StreamSteps;
  StepStatus NextStepStatus;
  bool CreateSharedPoints;
  double CurrentTime{ 0.0 };
  bool HasCurrentTime{ false };
 
  virtual int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
  virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
 
  int FillOutputPortInformation(int port, vtkInformation* info) override;
 
  vtkDataArraySelection* PointDataArraySelection;
  vtkDataArraySelection* CellDataArraySelection;
  vtkDataArraySelection* FieldDataArraySelection;
  vtkDataArraySelection* CellGridAttributeArraySelection;
 
  vtkMultiProcessController* Controller;
 
  int ADIOSAttributeCheck(const std::string& name);
 
private:
  vtkFidesReader(const vtkFidesReader&) = delete;
  void operator=(const vtkFidesReader&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif