VTK  9.2.6
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=========================================================================*/
26#ifndef vtkPhyloXMLTreeWriter_h
27#define vtkPhyloXMLTreeWriter_h
28
29#include "vtkIOInfovisModule.h" // For export macro
30#include "vtkSmartPointer.h" // For SP ivars
31#include "vtkStdString.h" // For get/set ivars
32#include "vtkXMLWriter.h"
33
34class vtkStringArray;
35class vtkTree;
37
38class VTKIOINFOVIS_EXPORT vtkPhyloXMLTreeWriter : public vtkXMLWriter
39{
40public:
43 void PrintSelf(ostream& os, vtkIndent indent) override;
44
46
50 vtkTree* GetInput(int port);
52
56 const char* GetDefaultFileExtension() override;
57
59
66 vtkGetMacro(EdgeWeightArrayName, vtkStdString);
67 vtkSetMacro(EdgeWeightArrayName, vtkStdString);
69
71
78 vtkGetMacro(NodeNameArrayName, vtkStdString);
79 vtkSetMacro(NodeNameArrayName, vtkStdString);
81
87 void IgnoreArray(const char* arrayName);
88
89protected:
91 ~vtkPhyloXMLTreeWriter() override = default;
92
93 int WriteData() override;
94
95 const char* GetDataSetName() override;
96 int StartFile() override;
97 int EndFile() override;
98
104 const char* elementName, const char* attributeName);
105
110
115 void WriteCladeElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* parentElement);
116
121 vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
122
127
131 void WriteConfidenceElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
132
137 void WriteColorElement(vtkTree* const input, vtkIdType vertex, vtkXMLDataElement* element);
138
143
148 const char* GetArrayAttribute(vtkAbstractArray* array, const char* attributeName);
149
150 int FillInputPortInformation(int port, vtkInformation* info) override;
151
153
156
160
161private:
163 void operator=(const vtkPhyloXMLTreeWriter&) = delete;
164};
165
166#endif
Abstract superclass for all arrays.
a simple class to control print indentation
Definition: vtkIndent.h:40
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.
const char * GetDataSetName() override
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.
const char * GetDefaultFileExtension() override
Get the default file extension for files written by this writer.
int StartFile() override
void WriteConfidenceElement(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *element)
Write the confidence element for the specified vertex.
vtkTree * GetInput(int port)
Get the input to this writer.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
static vtkPhyloXMLTreeWriter * New()
void WriteTreeLevelProperties(vtkTree *input, vtkXMLDataElement *rootElement)
Search for any tree-level properties and write them out if they are found.
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
void WriteBranchLengthAttribute(vtkTree *const input, vtkIdType vertex, vtkXMLDataElement *element)
Write the branch length attribute for the specified vertex.
vtkTree * GetInput()
Get the input to this writer.
const char * GetArrayAttribute(vtkAbstractArray *array, const char *attributeName)
Get the value of the requested attribute from the specified array's vtkInformation.
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.
~vtkPhyloXMLTreeWriter() override=default
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:39
a vtkAbstractArray subclass for strings
A rooted tree data structure.
Definition: vtkTree.h:61
Represents an XML element and those nested inside.
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:65
int vtkIdType
Definition: vtkType.h:332