vtkWriter.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 vtkWriter_h
#define vtkWriter_h

#include "vtkAlgorithm.h"
#include "vtkDeprecation.h"  // For VTK_DEPRECATED_9_6_0 VTK_DEPRECATED_IN_9_7_0
#include "vtkIOCoreModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkDataObject;

#define VTK_ASCII 1
#define VTK_BINARY 2

class VTKIOCORE_EXPORT vtkWriter : public vtkAlgorithm
{
public:
  vtkTypeMacro(vtkWriter, vtkAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual int Write();


  static void EncodeString(char* resname, const char* name);

  VTK_DEPRECATED_IN_9_6_0("Use the version without doublePercent instead.")
  static void EncodeString(char* resname, const char* name, bool doublePercent);


  static void EncodeWriteString(ostream* out, const char* name);

  VTK_DEPRECATED_IN_9_6_0("Use the version without doublePercent instead.")
  static void EncodeWriteString(ostream* out, const char* name, bool doublePercent);


  void SetInputData(vtkDataObject* input);
  void SetInputData(int index, vtkDataObject* input);

  vtkDataObject* GetInput();
  vtkDataObject* GetInput(int port);

protected:
  vtkWriter();
  ~vtkWriter() override;

  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);

  // When removing this deprecation remove this whole section and keep the section below instead
  VTK_DEPRECATED_IN_9_7_0("Use and override WriteDataAndReturn instead.")
  virtual void WriteData();
  virtual bool WriteDataAndReturn();

#if 0

  virtual bool WriteDataAndReturn() = 0;
#endif

  vtkTimeStamp WriteTime;

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

  // VTK_DEPRECATED_IN_9_7_0 remove both members
  bool WriteDataFlag = true;
  bool WriteDataOverrideError = false;
};

VTK_ABI_NAMESPACE_END
#endif