A toolkit for working with phylogenetic data.
v0.18.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
utils/formats/nexus/writer.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_FORMATS_NEXUS_WRITER_H_
2 #define GENESIS_UTILS_FORMATS_NEXUS_WRITER_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 <string>
36 
37 namespace genesis {
38 namespace utils {
39 
40 // =================================================================================================
41 // Forward Declarations
42 // =================================================================================================
43 
44 class NexusDocument;
45 
46 // =================================================================================================
47 // Nexus Writer
48 // =================================================================================================
49 
54 {
55 public:
56 
57  // ---------------------------------------------------------------------
58  // Constructor and Rule of Five
59  // ---------------------------------------------------------------------
60 
61  NexusWriter() = default;
62  ~NexusWriter() = default;
63 
64  NexusWriter( NexusWriter const& ) = default;
65  NexusWriter( NexusWriter&& ) = default;
66 
67  NexusWriter& operator= ( NexusWriter const& ) = default;
68  NexusWriter& operator= ( NexusWriter&& ) = default;
69 
70  // ---------------------------------------------------------------------
71  // Write Functions
72  // ---------------------------------------------------------------------
73 
74  void to_stream ( NexusDocument const& doc, std::ostream& out ) const;
75  void to_file ( NexusDocument const& doc, std::string const& filename) const;
76  void to_string ( NexusDocument const& doc, std::string& output) const;
77  std::string to_string ( NexusDocument const& doc) const;
78 };
79 
80 } // namespace utils
81 } // namespace genesis
82 
83 #endif // include guard
void to_stream(NexusDocument const &doc, std::ostream &out) const
void to_string(NexusDocument const &doc, std::string &output) const
void to_file(NexusDocument const &doc, std::string const &filename) const
NexusWriter & operator=(NexusWriter const &)=default