VTK  9.0.1
vtkPhyloXMLTreeWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPhyloXMLTreeWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
23 #ifndef vtkPhyloXMLTreeWriter_h
24 #define vtkPhyloXMLTreeWriter_h
25 
26 #include "vtkIOInfovisModule.h" // For export macro
27 #include "vtkSmartPointer.h" // For SP ivars
28 #include "vtkStdString.h" // For get/set ivars
29 #include "vtkXMLWriter.h"
30 
31 class vtkStringArray;
32 class vtkTree;
33 class vtkXMLDataElement;
34 
35 class VTKIOINFOVIS_EXPORT vtkPhyloXMLTreeWriter : public vtkXMLWriter
36 {
37 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
49 
53  const char* GetDefaultFileExtension() override;
54 
56 
63  vtkGetMacro(EdgeWeightArrayName, vtkStdString);
64  vtkSetMacro(EdgeWeightArrayName, vtkStdString);
66 
68 
75  vtkGetMacro(NodeNameArrayName, vtkStdString);
76  vtkSetMacro(NodeNameArrayName, vtkStdString);
78 
84  void IgnoreArray(const char* arrayName);
85 
86 protected:
88  ~vtkPhyloXMLTreeWriter() override {}
89 
90  int WriteData() override;
91 
92  const char* GetDataSetName() override;
93  int StartFile() override;
94  int EndFile() override;
95 
101  const char* elementName, const char* attributeName);
102 
107 
112  void WriteCladeElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* parentElement);
113 
118  vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
119 
124 
128  void WriteConfidenceElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
129 
134  void WriteColorElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
135 
140 
145  const char* GetArrayAttribute(vtkAbstractArray* array, const char* attributeName);
146 
148 
150 
153 
157 
158 private:
160  void operator=(const vtkPhyloXMLTreeWriter&) = delete;
161 };
162 
163 #endif
Abstract superclass for all arrays.
a simple class to control print indentation
Definition: vtkIndent.h:34
Store vtkAlgorithm input/output information.
write vtkTree data to PhyloXML format.
void WriteNameElement(vtkIdType vertex, vtkXMLDataElement *element)
Write the name element for the specified vertex.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractArray * EdgeWeightArray
void WriteTreeLevelElement(vtkTree *input, vtkXMLDataElement *rootElement, const char *elementName, const char *attributeName)
Check for an optional, tree-level element and write it out if it is found.
int StartFile() override
vtkTree * GetInput(int port)
void WriteConfidenceElement(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *element)
Write the confidence element for the specified vertex.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void WriteTreeLevelProperties(vtkTree *input, vtkXMLDataElement *rootElement)
Search for any tree-level properties and write them out if they are found.
vtkTree * GetInput()
Get the input to this writer.
int WriteData() override
vtkSmartPointer< vtkStringArray > Blacklist
void IgnoreArray(const char *arrayName)
Do not include name the VertexData array in the PhyloXML output of this writer.
vtkInformation * InputInformation
int EndFile() override
void WriteCladeElement(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *parentElement)
Convert one vertex to PhyloXML.
vtkAbstractArray * NodeNameArray
static vtkPhyloXMLTreeWriter * New()
void WriteBranchLengthAttribute(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *element)
Write the branch length attribute for the specified vertex.
const char * GetArrayAttribute(vtkAbstractArray *array, const char *attributeName)
Get the value of the requested attribute from the specified array's vtkInformation.
const char * GetDataSetName() override
void WritePropertyElement(vtkAbstractArray *array, vtkIdType vertex, vtkXMLDataElement *element)
Write a property element as a child of the specified vtkXMLDataElement.
void WriteColorElement(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *element)
Write the color element and its subelements (red, green, blue) for the specified vertex.
const char * GetDefaultFileExtension() override
Get the default file extension for files written by this writer.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:35
a vtkAbstractArray subclass for strings
A rooted tree data structure.
Definition: vtkTree.h:55
Represents an XML element and those nested inside.
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:62
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
int vtkIdType
Definition: vtkType.h:338