fasta_writer.hpp

Go to the documentation of this file.

#ifndef GENESIS_SEQUENCE_FORMATS_FASTA_WRITER_H_
#define GENESIS_SEQUENCE_FORMATS_FASTA_WRITER_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 Lucas Czech and HITS gGmbH
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include "genesis/utils/io/output_target.hpp"
 
#include <iosfwd>
#include <string>
 
namespace genesis {
namespace sequence {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Sequence;
class SequenceSet;
 
// =================================================================================================
//     Fasta Writer
// =================================================================================================
 
class FastaWriter
{
public:
 
    // ---------------------------------------------------------------------
    //     Typedefs and Enums
    // ---------------------------------------------------------------------
 
    enum class AbundanceNotation
    {
        kNone,
 
        kUnderscore,
 
        kSize
    };
 
    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------
 
    FastaWriter()  = default;
    ~FastaWriter() = default;
 
    FastaWriter( FastaWriter const& ) = default;
    FastaWriter( FastaWriter&& )      = default;
 
    FastaWriter& operator= ( FastaWriter const& ) = default;
    FastaWriter& operator= ( FastaWriter&& )      = default;
 
    // ---------------------------------------------------------------------
    //     Writing
    // ---------------------------------------------------------------------
 
    void write( Sequence const& sequence, std::shared_ptr<utils::BaseOutputTarget> target ) const;
 
    void write( SequenceSet const& sequence_set, std::shared_ptr<utils::BaseOutputTarget> target ) const;
 
    void write_sequence( Sequence const& sequence, std::ostream& os ) const;
 
    // ---------------------------------------------------------------------
    //     Properties
    // ---------------------------------------------------------------------
 
    FastaWriter& line_length( size_t value );
 
    size_t       line_length() const;
 
    FastaWriter& abundance_notation( AbundanceNotation value );
 
    AbundanceNotation abundance_notation() const;
 
    // ---------------------------------------------------------------------
    //     Members
    // ---------------------------------------------------------------------
 
private:
 
    size_t line_length_ = 80;
    AbundanceNotation abundance_notation_ = AbundanceNotation::kNone;
 
};
 
} // namespace sequence
} // namespace genesis
 
#endif // include guard