vtkXMLDataWriterHelper.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkXMLDataWriterHelper.h
 
  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 vtkXMLDataWriterHelper_h
#define vtkXMLDataWriterHelper_h
 
#include "vtkIOParallelXMLModule.h" // For export macro
#include "vtkXMLWriter.h"
 
class vtkCompositeDataSet;
class vtkXMLDataElement;
class vtkXMLWriter2;
 
class VTKIOPARALLELXML_EXPORT vtkXMLDataWriterHelper : public vtkXMLWriter
{
public:
  static vtkXMLDataWriterHelper* New();
  vtkTypeMacro(vtkXMLDataWriterHelper, vtkXMLWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetWriter(vtkXMLWriter2*);
  vtkGetObjectMacro(Writer, vtkXMLWriter2);
 
 
  bool OpenFile();
  bool BeginWriting();
  bool EndWriting();
 
  bool AddGlobalFieldData(vtkCompositeDataSet* dataset);
 
  bool AddXML(vtkXMLDataElement* xmlElement);
 
 
  void SetDataSetName(const std::string& name) { this->DataSetName = name; }
  void SetDataSetVersion(int major, int minor)
  {
    this->DataSetVersion[0] = major;
    this->DataSetVersion[1] = minor;
  }
 
  const char* GetDefaultFileExtension() override { return nullptr; }
 
protected:
  vtkXMLDataWriterHelper();
  ~vtkXMLDataWriterHelper() override;
 
  const char* GetDataSetName() override { return this->DataSetName.c_str(); }
  int GetDataSetMajorVersion() override { return this->DataSetVersion[0]; }
  int GetDataSetMinorVersion() override { return this->DataSetVersion[1]; }
 
private:
  vtkXMLDataWriterHelper(const vtkXMLDataWriterHelper&) = delete;
  void operator=(const vtkXMLDataWriterHelper&) = delete;
 
  vtkXMLWriter2* Writer;
  std::string DataSetName;
  int DataSetVersion[2];
};
 
#endif