vtkDataWriter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkDataWriter.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 vtkDataWriter_h
#define vtkDataWriter_h

#include "vtkIOLegacyModule.h" // For export macro
#include "vtkWriter.h"

class vtkCellArray;
class vtkDataArray;
class vtkDataSet;
class vtkFieldData;
class vtkGraph;
class vtkInformation;
class vtkInformationKey;
class vtkPoints;
class vtkTable;

class VTKIOLEGACY_EXPORT vtkDataWriter : public vtkWriter
{
public:
  vtkTypeMacro(vtkDataWriter,vtkWriter);
  void PrintSelf(ostream& os, vtkIndent indent);

  static vtkDataWriter *New();


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


  vtkSetMacro(WriteToOutputString,int);
  vtkGetMacro(WriteToOutputString,int);
  vtkBooleanMacro(WriteToOutputString,int);


  vtkGetMacro(OutputStringLength, int);
  vtkGetStringMacro(OutputString);
  unsigned char *GetBinaryOutputString()
  {
      return reinterpret_cast<unsigned char *>(this->OutputString);
  }

  vtkStdString GetOutputStdString();

  char *RegisterAndGetOutputString();


  vtkSetStringMacro(Header);
  vtkGetStringMacro(Header);


  vtkSetMacro(WriteArrayMetaData, bool)
  vtkGetMacro(WriteArrayMetaData, bool)
  vtkBooleanMacro(WriteArrayMetaData, bool)


  vtkSetClampMacro(FileType,int,VTK_ASCII,VTK_BINARY);
  vtkGetMacro(FileType,int);
  void SetFileTypeToASCII() {this->SetFileType(VTK_ASCII);};
  void SetFileTypeToBinary() {this->SetFileType(VTK_BINARY);};


  vtkSetStringMacro(ScalarsName);
  vtkGetStringMacro(ScalarsName);


  vtkSetStringMacro(VectorsName);
  vtkGetStringMacro(VectorsName);


  vtkSetStringMacro(TensorsName);
  vtkGetStringMacro(TensorsName);


  vtkSetStringMacro(NormalsName);
  vtkGetStringMacro(NormalsName);


  vtkSetStringMacro(TCoordsName);
  vtkGetStringMacro(TCoordsName);


  vtkSetStringMacro(GlobalIdsName);
  vtkGetStringMacro(GlobalIdsName);


  vtkSetStringMacro(PedigreeIdsName);
  vtkGetStringMacro(PedigreeIdsName);


  vtkSetStringMacro(EdgeFlagsName);
  vtkGetStringMacro(EdgeFlagsName);


  vtkSetStringMacro(LookupTableName);
  vtkGetStringMacro(LookupTableName);


  vtkSetStringMacro(FieldDataName);
  vtkGetStringMacro(FieldDataName);

  virtual ostream *OpenVTKFile();

  int WriteHeader(ostream *fp);

  int WritePoints(ostream *fp, vtkPoints *p);

  int WriteCoordinates(ostream *fp, vtkDataArray *coords, int axes);

  int WriteCells(ostream *fp, vtkCellArray *cells, const char *label);

  int WriteCellData(ostream *fp, vtkDataSet *ds);

  int WritePointData(ostream *fp, vtkDataSet *ds);

  int WriteEdgeData(ostream *fp, vtkGraph *g);

  int WriteVertexData(ostream *fp, vtkGraph *g);

  int WriteRowData(ostream *fp, vtkTable *g);

  int WriteFieldData(ostream *fp, vtkFieldData *f);

  int WriteDataSetData(ostream *fp, vtkDataSet *ds);

  void CloseVTKFile(ostream *fp);


protected:
  vtkDataWriter();
  ~vtkDataWriter();

  int WriteToOutputString;
  char *OutputString;
  int OutputStringLength;

  void WriteData(); //dummy method to allow this class to be instantiated and delegated to

  char *FileName;
  char *Header;
  int FileType;

  bool WriteArrayMetaData;

  char *ScalarsName;
  char *VectorsName;
  char *TensorsName;
  char *TCoordsName;
  char *NormalsName;
  char *LookupTableName;
  char *FieldDataName;
  char* GlobalIdsName;
  char* PedigreeIdsName;
  char* EdgeFlagsName;

  int WriteArray(ostream *fp, int dataType, vtkAbstractArray *data, const char *format,
                 int num, int numComp);
  int WriteScalarData(ostream *fp, vtkDataArray *s, int num);
  int WriteVectorData(ostream *fp, vtkDataArray *v, int num);
  int WriteNormalData(ostream *fp, vtkDataArray *n, int num);
  int WriteTCoordData(ostream *fp, vtkDataArray *tc, int num);
  int WriteTensorData(ostream *fp, vtkDataArray *t, int num);
  int WriteGlobalIdData(ostream *fp, vtkDataArray *g, int num);
  int WritePedigreeIdData(ostream *fp, vtkAbstractArray *p, int num);
  int WriteEdgeFlagsData(ostream *fp, vtkDataArray *edgeFlags, int num);

  bool CanWriteInformationKey(vtkInformation *info, vtkInformationKey *key);

  int WriteInformation(ostream *fp, vtkInformation *info);

private:
  vtkDataWriter(const vtkDataWriter&) VTK_DELETE_FUNCTION;
  void operator=(const vtkDataWriter&) VTK_DELETE_FUNCTION;
};

#endif