vtkFileSeriesWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkFileSeriesWriter_h
#define vtkFileSeriesWriter_h

#include "vtkDataObjectAlgorithm.h"
#include "vtkPVVTKExtensionsIOCoreModule.h" //needed for exports
class vtkClientServerInterpreter;

class VTKPVVTKEXTENSIONSIOCORE_EXPORT vtkFileSeriesWriter : public vtkDataObjectAlgorithm
{
public:
  static vtkFileSeriesWriter* New();
  vtkTypeMacro(vtkFileSeriesWriter, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetWriter(vtkAlgorithm*);
  vtkGetObjectMacro(Writer, vtkAlgorithm);

  vtkMTimeType GetMTime() override;


  vtkSetStringMacro(FileNameMethod);
  vtkGetStringMacro(FileNameMethod);


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);

  int Write();


  vtkGetMacro(WriteAllTimeSteps, int);
  vtkSetMacro(WriteAllTimeSteps, int);
  vtkBooleanMacro(WriteAllTimeSteps, int);


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


  vtkGetStringMacro(FileNameSuffix);
  vtkSetStringMacro(FileNameSuffix);


  vtkGetMacro(MinTimeStep, int);
  vtkSetClampMacro(MinTimeStep, int, 0, VTK_INT_MAX);


  vtkGetMacro(MaxTimeStep, int);
  vtkSetMacro(MaxTimeStep, int);


  vtkGetMacro(TimeStepStride, int);
  vtkSetClampMacro(TimeStepStride, int, 1, VTK_INT_MAX);

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

  void SetInterpreter(vtkClientServerInterpreter* interp) { this->Interpreter = interp; }

  static bool SuffixValidation(char* fileNameSuffix);

protected:
  vtkFileSeriesWriter();
  ~vtkFileSeriesWriter() override;

  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

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

  void SetWriterFileName(const char* fname);
  bool WriteATimestep(vtkDataObject*, vtkInformation* inInfo);
  bool WriteJsonFile(vtkInformation* inInfo);
  void WriteInternal();
  bool AppendFileNameForTimeStep(std::ostringstream& fname, int timeIndex, bool appendPath = true);

  vtkAlgorithm* Writer = nullptr;
  char* FileNameMethod = nullptr;

  int WriteAllTimeSteps = 0;
  bool WriteJsonMetaFile = false;
  char* FileNameSuffix = nullptr;
  int NumberOfTimeSteps = 1;
  int CurrentTimeIndex = 0;
  int MinTimeStep = 0;
  int MaxTimeStep = -1;
  int TimeStepStride = 1;

  // The name of the output file.
  char* FileName = nullptr;

  vtkClientServerInterpreter* Interpreter = nullptr;
};

#endif