A toolkit for working with phylogenetic data.
v0.18.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fasta_writer.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_SEQUENCE_FORMATS_FASTA_WRITER_H_
2 #define GENESIS_SEQUENCE_FORMATS_FASTA_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 sequence {
39 
40 // =================================================================================================
41 // Forward Declarations
42 // =================================================================================================
43 
44 class Sequence;
45 class SequenceSet;
46 
47 // =================================================================================================
48 // Fasta Writer
49 // =================================================================================================
50 
72 {
73 public:
74 
75  // ---------------------------------------------------------------------
76  // Constructor and Rule of Five
77  // ---------------------------------------------------------------------
78 
79  FastaWriter() = default;
80  ~FastaWriter() = default;
81 
82  FastaWriter( FastaWriter const& ) = default;
83  FastaWriter( FastaWriter&& ) = default;
84 
85  FastaWriter& operator= ( FastaWriter const& ) = default;
86  FastaWriter& operator= ( FastaWriter&& ) = default;
87 
88  // ---------------------------------------------------------------------
89  // Writing
90  // ---------------------------------------------------------------------
91 
95  void write_sequence( Sequence const& seq, std::ostream& os ) const;
96 
100  void to_stream ( SequenceSet const& sset, std::ostream& os ) const;
101 
110  void to_file ( SequenceSet const& sset, std::string const& fn ) const;
111 
118  std::string to_string ( SequenceSet const& sset ) const;
119 
120  // ---------------------------------------------------------------------
121  // Properties
122  // ---------------------------------------------------------------------
123 
131  FastaWriter& line_length( size_t value );
132 
138  size_t line_length() const;
139 
148  FastaWriter& enable_metadata( bool value );
149 
155  bool enable_metadata();
156 
157  // ---------------------------------------------------------------------
158  // Members
159  // ---------------------------------------------------------------------
160 
161 private:
162 
163  size_t line_length_ = 80;
164  bool enable_metadata_ = true;
165 
166 };
167 
168 } // namespace sequence
169 } // namespace genesis
170 
171 #endif // include guard
void to_stream(SequenceSet const &sset, std::ostream &os) const
Write Sequences of a SequenceSet to a stream, using the Fasta format.
void to_file(SequenceSet const &sset, std::string const &fn) const
Write Sequences of a SequenceSet to a file, using the Fasta format.
size_t line_length() const
Get the current line length.
FastaWriter & operator=(FastaWriter const &)=default
Store a set of Sequences.
void write_sequence(Sequence const &seq, std::ostream &os) const
Write a single Sequence to an output stream in Fasta format.
bool enable_metadata()
Return whether currently the FastaWriter is set to write metadata.
std::string to_string(SequenceSet const &sset) const
Return Sequences of a SequenceSet in form of a Fasta formatted string.