vtkPhyloXMLTreeWriter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkPhyloXMLTreeWriter.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 vtkPhyloXMLTreeWriter_h
#define vtkPhyloXMLTreeWriter_h
 
#include "vtkIOInfovisModule.h" // For export macro
#include "vtkSmartPointer.h"    // For SP ivars
#include "vtkStdString.h"       // For get/set ivars
#include "vtkXMLWriter.h"
 
class vtkStringArray;
class vtkTree;
class vtkXMLDataElement;
 
class VTKIOINFOVIS_EXPORT vtkPhyloXMLTreeWriter : public vtkXMLWriter
{
public:
  static vtkPhyloXMLTreeWriter* New();
  vtkTypeMacro(vtkPhyloXMLTreeWriter, vtkXMLWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkTree* GetInput();
  vtkTree* GetInput(int port);
 
  const char* GetDefaultFileExtension() override;
 
 
  vtkGetMacro(EdgeWeightArrayName, vtkStdString);
  vtkSetMacro(EdgeWeightArrayName, vtkStdString);
 
 
  vtkGetMacro(NodeNameArrayName, vtkStdString);
  vtkSetMacro(NodeNameArrayName, vtkStdString);
 
  void IgnoreArray(const char* arrayName);
 
protected:
  vtkPhyloXMLTreeWriter();
  ~vtkPhyloXMLTreeWriter() override = default;
 
  int WriteData() override;
 
  const char* GetDataSetName() override;
  int StartFile() override;
  int EndFile() override;
 
  void WriteTreeLevelElement(vtkTree* input, vtkXMLDataElement* rootElement,
    const char* elementName, const char* attributeName);
 
  void WriteTreeLevelProperties(vtkTree* input, vtkXMLDataElement* rootElement);
 
  void WriteCladeElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* parentElement);
 
  void WriteBranchLengthAttribute(
    vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
 
  void WriteNameElement(vtkIdType vertex, vtkXMLDataElement* element);
 
  void WriteConfidenceElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
 
  void WriteColorElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
 
  void WritePropertyElement(vtkAbstractArray* array, vtkIdType vertex, vtkXMLDataElement* element);
 
  const char* GetArrayAttribute(vtkAbstractArray* array, const char* attributeName);
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  vtkInformation* InputInformation;
 
  vtkStdString EdgeWeightArrayName;
  vtkStdString NodeNameArrayName;
 
  vtkAbstractArray* EdgeWeightArray;
  vtkAbstractArray* NodeNameArray;
  vtkSmartPointer<vtkStringArray> Blacklist;
 
private:
  vtkPhyloXMLTreeWriter(const vtkPhyloXMLTreeWriter&) = delete;
  void operator=(const vtkPhyloXMLTreeWriter&) = delete;
};
 
#endif