vtkXMLCompositeDataWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkXMLCompositeDataWriter_h
#define vtkXMLCompositeDataWriter_h
 
#include "vtkIOXMLModule.h"   // For export macro
#include "vtkStdString.h"     // needed for vtkStdString.
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
#include "vtkXMLWriter.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkCompositeDataSet;
class vtkXMLDataElement;
class vtkXMLCompositeDataWriterInternals;
 
class VTKIOXML_EXPORT VTK_MARSHALAUTO vtkXMLCompositeDataWriter : public vtkXMLWriter
{
public:
  vtkTypeMacro(vtkXMLCompositeDataWriter, vtkXMLWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  const char* GetDefaultFileExtension() override;



  vtkGetMacro(GhostLevel, int);
  vtkSetMacro(GhostLevel, int);


  vtkGetMacro(WriteMetaFile, int);
  virtual void SetWriteMetaFile(int flag);

  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
protected:
  vtkXMLCompositeDataWriter();
  ~vtkXMLCompositeDataWriter() override;

  int GetDataSetMajorVersion() override { return 1; }
  int GetDataSetMinorVersion() override { return 0; }

  vtkStdString CreatePieceFileName(int Piece);
 
  // see algorithm for more info
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
  int WriteData() override;
  const char* GetDataSetName() override;
 
  // Create a default executive.
  vtkExecutive* CreateDefaultExecutive() override;
 
  vtkInformation* InputInformation;

  virtual void FillDataTypes(vtkCompositeDataSet*);

  unsigned int GetNumberOfDataTypes();

  int* GetDataTypesPointer();
 
  // Methods to create the set of writers matching the set of inputs.
  void CreateWriters(vtkCompositeDataSet*);
  vtkXMLWriter* GetWriter(int index);
 
  // Methods to help construct internal file names.
  void SplitFileName();
  VTK_FILEPATH const char* GetFilePrefix();
  VTK_FILEPATH const char* GetFilePath();

  const char* GetDefaultFileExtensionForDataSet(int dataset_type);

  int WriteMetaFileIfRequested();
 
  // Make a directory.
  virtual void MakeDirectory(const char* name);
 
  // Remove a directory.
  void RemoveADirectory(const char* name);
 
  // Internal implementation details.
  vtkXMLCompositeDataWriterInternals* Internal;
 
  // The number of ghost levels to write for unstructured data.
  int GhostLevel;

  int WriteMetaFile;
 
  // Callback registered with the InternalProgressObserver.
  static void ProgressCallbackFunction(vtkObject*, unsigned long, void*, void*);
  // Progress callback from internal writer.
  virtual void ProgressCallback(vtkAlgorithm* w);
 
  // The observer to report progress from the internal writer.
  vtkCallbackCommand* InternalProgressObserver;

  virtual int WriteComposite(
    vtkCompositeDataSet* compositeData, vtkXMLDataElement* element, int& writerIdx) = 0;

  virtual int WriteNonCompositeData(
    vtkDataObject* dObj, vtkXMLDataElement* element, int& writerIdx, const char* fileName);

  virtual void RemoveWrittenFiles(const char* SubDirectory);
 
private:
  vtkXMLCompositeDataWriter(const vtkXMLCompositeDataWriter&) = delete;
  void operator=(const vtkXMLCompositeDataWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif