vtkCSVWriter.h

Go to the documentation of this file.

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

#include "vtkDataObject.h"                  // for vtkDataObject::FieldAssociations
#include "vtkPVVTKExtensionsIOCoreModule.h" // needed for exports
#include "vtkWriter.h"

#include <string> // for std::string
#include <vector> // for std::vector

class vtkDoubleArray;
class vtkMultiProcessController;
class vtkTable;

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


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


  vtkSetStringMacro(FieldDelimiter);
  vtkGetStringMacro(FieldDelimiter);


  vtkSetStringMacro(StringDelimiter);
  vtkGetStringMacro(StringDelimiter);


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


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


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


  vtkGetStringMacro(FileNameSuffix);
  vtkSetStringMacro(FileNameSuffix);


  vtkSetMacro(UseStringDelimiter, bool);
  vtkGetMacro(UseStringDelimiter, bool);


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


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


  vtkSetClampMacro(FieldAssociation, int, 0, vtkDataObject::NUMBER_OF_ASSOCIATIONS - 1);
  vtkGetMacro(FieldAssociation, int);


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


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


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


  std::string GetString(std::string string);

protected:
  vtkCSVWriter();
  ~vtkCSVWriter() override;

  void WriteData() override;

  // see algorithm for more info.
  // This writer takes in vtkTable, vtkDataSet or vtkCompositeDataSet.
  int FillInputPortInformation(int port, vtkInformation* info) override;

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

  // see algorithm for more info. needed here so we can request pieces.
  int ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  char* FileName;
  bool WriteAllTimeSteps;
  bool WriteAllTimeStepsSeparately;
  char* FileNameSuffix;
  char* FieldDelimiter;
  char* StringDelimiter;
  bool UseStringDelimiter;
  int Precision;
  bool UseScientificNotation;
  int FieldAssociation;
  bool AddMetaData;
  bool AddTimeStep;
  bool AddTime;

  vtkMultiProcessController* Controller;

  vtkDoubleArray* TimeValues;
  int CurrentTimeIndex;
  int NumberOfTimeSteps;

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

  class CSVFile;
};

#endif