A toolkit for working with phylogenetic data.
v0.24.0
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-2020 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 
35 
36 #include <iosfwd>
37 #include <string>
38 
39 namespace genesis {
40 namespace utils {
41 
42 // =================================================================================================
43 // Forward Declarations
44 // =================================================================================================
45 
46 class NexusDocument;
47 
48 // =================================================================================================
49 // Nexus Writer
50 // =================================================================================================
51 
56 {
57 public:
58 
59  // ---------------------------------------------------------------------
60  // Constructor and Rule of Five
61  // ---------------------------------------------------------------------
62 
63  NexusWriter() = default;
64  ~NexusWriter() = default;
65 
66  NexusWriter( NexusWriter const& ) = default;
67  NexusWriter( NexusWriter&& ) = default;
68 
69  NexusWriter& operator= ( NexusWriter const& ) = default;
70  NexusWriter& operator= ( NexusWriter&& ) = default;
71 
72  // ---------------------------------------------------------------------
73  // Write Functions
74  // ---------------------------------------------------------------------
75 
82  void write( NexusDocument const& document, std::shared_ptr<utils::BaseOutputTarget> target ) const;
83 
89  std::string to_string( NexusDocument const& document ) const;
90 };
91 
92 } // namespace utils
93 } // namespace genesis
94 
95 #endif // include guard
void write(NexusDocument const &document, std::shared_ptr< utils::BaseOutputTarget > target) const
Write a NexusDocument to an output target, using the Nexus format.
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
std::string to_string(NexusDocument const &document) const
Directly return a NexusDocument as a string in Nexus format.
NexusWriter & operator=(NexusWriter const &)=default