A toolkit for working with phylogenetic data.
v0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
detailed.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_TREE_PRINTER_DETAILED_H_
2 #define GENESIS_TREE_PRINTER_DETAILED_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2017 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
34 #include <iosfwd>
35 #include <functional>
36 #include <string>
37 
38 namespace genesis {
39 namespace tree {
40 
41 // =================================================================================================
42 // Forward Declarations
43 // =================================================================================================
44 
45 class Tree;
46 class TreeNode;
47 class TreeEdge;
48 class TreeLink;
49 
50 // =================================================================================================
51 // Printer Detailed
52 // =================================================================================================
53 
59 {
60 public:
61 
62  // -------------------------------------------------------------------------
63  // Constructor and Rule of Five
64  // -------------------------------------------------------------------------
65 
66  PrinterDetailed() = default;
67  ~PrinterDetailed() = default;
68 
69  PrinterDetailed( PrinterDetailed const& ) = default;
70  PrinterDetailed( PrinterDetailed&& ) = default;
71 
72  PrinterDetailed& operator= ( PrinterDetailed const& ) = default;
74 
75  // -------------------------------------------------------------------------
76  // Print
77  // -------------------------------------------------------------------------
78 
79  void print( std::ostream& out, Tree const& tree ) const;
80  std::string print( Tree const& tree ) const;
81 
82  // std::string operator() ( Tree const& tree );
83 
84  // -------------------------------------------------------------------------
85  // Properties
86  // -------------------------------------------------------------------------
87 
88  bool use_color() const
89  {
90  return use_color_;
91  }
92 
93  PrinterDetailed& use_color( bool value )
94  {
95  use_color_ = value;
96  return *this;
97  }
98 
99  // -------------------------------------------------------------------------
100  // Member Data
101  // -------------------------------------------------------------------------
102 
103 private:
104 
105  bool use_color_ = true;
106 };
107 
108 } // namespace tree
109 } // namespace genesis
110 
111 #endif // include guard
PrinterDetailed & use_color(bool value)
Definition: detailed.hpp:93
Class for representing phylogenetic trees.
Definition: tree/tree.hpp:95
PrinterDetailed & operator=(PrinterDetailed const &)=default
Print a text representation of the Tree, showing all nodes, edges and links with their indices...
Definition: detailed.hpp:58
void print(std::ostream &out, Tree const &tree) const
Definition: detailed.cpp:54