vtkFidesWriter.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 vtkFidesWriter_h
#define vtkFidesWriter_h

#include "vtkIOFidesModule.h" // For export macro
#include "vtkNew.h"           // For vtkNew
#include "vtkWriter.h"

#include <memory> // for std::unique_ptr

VTK_ABI_NAMESPACE_BEGIN
class vtkDataArraySelection;
class vtkInformationIntegerKey;
class vtkMultiProcessController;

class VTKIOFIDES_EXPORT vtkFidesWriter : public vtkWriter
{
public:
  enum EngineTypes
  {
    BPFile,
    SST
  };

  static vtkFidesWriter* New();
  vtkTypeMacro(vtkFidesWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  vtkSetFilePathMacro(AdiosConfigFile);
  vtkGetFilePathMacro(AdiosConfigFile);


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


  vtkDataArraySelection* GetArraySelection(int association);
  vtkDataArraySelection* GetPointDataArraySelection();
  vtkDataArraySelection* GetCellDataArraySelection();
  vtkDataArraySelection* GetFieldDataArraySelection();


  vtkSetVector2Macro(TimeStepRange, int);
  vtkGetVector2Macro(TimeStepRange, int);
  vtkSetClampMacro(TimeStepStride, int, 1, VTK_INT_MAX);
  vtkGetMacro(TimeStepStride, int);


  vtkSetMacro(Engine, int);
  vtkGetMacro(Engine, int);


  void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);

protected:
  vtkFidesWriter();
  ~vtkFidesWriter() override;

  int FillInputPortInformation(int port, vtkInformation* info) override;
  int ProcessRequest(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  bool WriteDataAndReturn() override;

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

  struct FidesWriterImpl;
  std::unique_ptr<FidesWriterImpl> Impl;

  vtkMultiProcessController* Controller;
  char* FileName;
  char* AdiosConfigFile;
  bool ChooseFieldsToWrite;
  int TimeStepRange[2];
  int TimeStepStride;
  int Engine;

  vtkNew<vtkDataArraySelection> ArraySelection[3];
};

VTK_ABI_NAMESPACE_END
#endif