SeqAn3
output_format_concept.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
42 #include <fstream>
43 #include <string>
44 #include <vector>
45 
51 
52 namespace seqan3
53 {
54 
65 template <typename t>
67 concept sequence_file_output_format_concept = requires (t & v,
68  std::ofstream & f,
69  sequence_file_output_options & options,
70  dna5_vector & seq,
71  std::string & id,
72  std::vector<phred42> & qual,
73  std::vector<dna5q> & seq_qual)
74 {
75  t::file_extensions;
76 
77  { v.write(f, options, seq, id, qual) } -> void;
78  { v.write(f, options, std::ignore, id, std::ignore) } -> void;
79  { v.write(f, options, std::ignore, std::ignore, std::ignore) } -> void;
80  // the last is required to be compile time valid, but should always throw at run-time.
81 };
83 
120 
122 } // namespace seqan3
123 
124 namespace seqan3::detail
125 {
126 
132 template <typename t>
133 constexpr bool is_type_list_of_sequence_file_output_formats_v = false;
134 
140 template <typename ... ts>
141 constexpr bool is_type_list_of_sequence_file_output_formats_v<type_list<ts...>> =
142  (sequence_file_output_format_concept<ts> && ...);
143 
148 template <typename t>
149 concept type_list_of_sequence_file_output_formats_concept = is_type_list_of_sequence_file_output_formats_v<t>;
150 } // namespace seqan3::detail
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
Contains seqan3::dna5, container aliases and string literals.
Provides seqan3::sequence_file_output_options.
Provides seqan3::type_list and auxiliary metafunctions.
Definition: aligned_sequence_concept.hpp:288
Contains seqan3::phred42 quality scores.
meta::list< types... > type_list
Type that contains multiple types, an alias for meta::list.
Definition: type_list.hpp:54
Contains aliases for qualified.