vtkArrayWriter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkArrayWriter.h
 
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
 
#ifndef vtkArrayWriter_h
#define vtkArrayWriter_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkStdString.h"    // For string API
#include "vtkWriter.h"
 
class vtkArray;
 
class VTKIOCORE_EXPORT vtkArrayWriter : public vtkWriter
{
public:
  static vtkArrayWriter* New();
  vtkTypeMacro(vtkArrayWriter, vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
 
  vtkSetMacro(Binary, vtkTypeBool);
  vtkGetMacro(Binary, vtkTypeBool);
  vtkBooleanMacro(Binary, vtkTypeBool);
 
  virtual vtkStdString GetOutputString() { return this->OutputString; }
 
 
  vtkSetMacro(WriteToOutputString, bool);
  vtkGetMacro(WriteToOutputString, bool);
  vtkBooleanMacro(WriteToOutputString, bool);
 
  int Write() override; // This is necessary to get Write() wrapped for scripting languages.
 
  bool Write(const vtkStdString& FileName, bool WriteBinary = false);
 
  static bool Write(vtkArray* array, const vtkStdString& file_name, bool WriteBinary = false);
 
  bool Write(ostream& stream, bool WriteBinary = false);
 
  static bool Write(vtkArray* array, ostream& stream, bool WriteBinary = false);
 
  vtkStdString Write(bool WriteBinary);
 
  static vtkStdString Write(vtkArray* array, bool WriteBinary = false);
 
protected:
  vtkArrayWriter();
  ~vtkArrayWriter() override;
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
  void WriteData() override;
 
  char* FileName;
  vtkTypeBool Binary;
  bool WriteToOutputString;
  vtkStdString OutputString;
 
private:
  vtkArrayWriter(const vtkArrayWriter&) = delete;
  void operator=(const vtkArrayWriter&) = delete;
};
 
#endif