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 "vtkXMLWriter.h"
#include "vtkSmartPointer.h"    // For SP ivars
#include "vtkStdString.h"       // For get/set ivars
 
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);
 
 
  vtkTree* GetInput();
  vtkTree* GetInput(int port);
 
  virtual const char* GetDefaultFileExtension();
 
 
  vtkGetMacro(EdgeWeightArrayName, vtkStdString);
  vtkSetMacro(EdgeWeightArrayName, vtkStdString);
 
 
  vtkGetMacro(NodeNameArrayName, vtkStdString);
  vtkSetMacro(NodeNameArrayName, vtkStdString);
 
  void IgnoreArray(const char * arrayName);
 
protected:
  vtkPhyloXMLTreeWriter();
  ~vtkPhyloXMLTreeWriter() {}
 
  virtual int WriteData();
 
  virtual const char* GetDataSetName();
  virtual int StartFile();
  virtual int EndFile();
 
 
  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);
 
  virtual int FillInputPortInformation(int port, vtkInformation *info);
 
  vtkInformation* InputInformation;
 
  vtkStdString EdgeWeightArrayName;
  vtkStdString NodeNameArrayName;
 
  vtkAbstractArray *EdgeWeightArray;
  vtkAbstractArray *NodeNameArray;
  vtkSmartPointer<vtkStringArray> Blacklist;
 
private:
  vtkPhyloXMLTreeWriter(const vtkPhyloXMLTreeWriter&);  // Not implemented.
  void operator=(const vtkPhyloXMLTreeWriter&);  // Not implemented.
};
 
#endif