SeqAn3 3.1.0
The Modern C++ library for sequence analysis.
record.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
13#pragma once
14
15#include <seqan3/io/record.hpp>
16
17namespace seqan3
18{
27template <typename field_types, typename field_ids>
28class sequence_record : public record<field_types, field_ids>
29{
32
34 using tuple_base_t = typename base_t::base_type;
35
37 template <field f>
38 using field_constant = typename base_t::template field_constant<f>;
39
40 using base_t::get_impl;
41public:
45 sequence_record() = default;
46 sequence_record(sequence_record const &) = default;
50 ~sequence_record() = default;
51
53 using base_t::base_t;
55
57 decltype(auto) id() &&
58 {
59 return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t &&>(*this));
60 }
62 decltype(auto) id() const &&
63 {
64 return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t const &&>(*this));
65 }
67 decltype(auto) id() &
68 {
69 return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t &>(*this));
70 }
72 decltype(auto) id() const &
73 {
74 return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t const &>(*this));
75 }
76
78 decltype(auto) sequence() &&
79 {
80 return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t &&>(*this));
81 }
83 decltype(auto) sequence() const &&
84 {
85 return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t const &&>(*this));
86 }
88 decltype(auto) sequence() &
89 {
90 return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t &>(*this));
91 }
93 decltype(auto) sequence() const &
94 {
95 return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t const &>(*this));
96 }
97
99 decltype(auto) base_qualities() &&
100 {
101 return get_impl(field_constant<seqan3::field::qual>{}, static_cast<tuple_base_t &&>(*this));
102 }
104 decltype(auto) base_qualities() const &&
105 {
106 return get_impl(field_constant<seqan3::field::qual>{}, static_cast<tuple_base_t const &&>(*this));
107 }
109 decltype(auto) base_qualities() &
110 {
111 return get_impl(field_constant<seqan3::field::qual>{}, static_cast<tuple_base_t &>(*this));
112 }
114 decltype(auto) base_qualities() const &
115 {
116 return get_impl(field_constant<seqan3::field::qual>{}, static_cast<tuple_base_t const &>(*this));
117 }
118};
119} // namespace seqan3
120
121namespace std
122{
123
129template <typename field_types, typename field_ids>
130struct tuple_size<seqan3::sequence_record<field_types, field_ids>>
131 : tuple_size<typename seqan3::sequence_record<field_types, field_ids>::base_type>
132{};
133
139template <size_t elem_no, typename field_types, typename field_ids>
140struct tuple_element<elem_no, seqan3::sequence_record<field_types, field_ids>>
141 : tuple_element<elem_no, typename seqan3::sequence_record<field_types, field_ids>::base_type>
142{};
143
144} // namespace std
The record type of seqan3::sequence_file_input.
Definition: record.hpp:29
decltype(auto) base_qualities() &
The qualities, usually in Phred score notation.
Definition: record.hpp:109
decltype(auto) sequence() const &&
The "sequence", usually a range of nucleotides or amino acids.
Definition: record.hpp:83
sequence_record()=default
Defaulted.
decltype(auto) sequence() const &
The "sequence", usually a range of nucleotides or amino acids.
Definition: record.hpp:93
decltype(auto) base_qualities() const &&
The qualities, usually in Phred score notation.
Definition: record.hpp:104
sequence_record(sequence_record const &)=default
Defaulted.
decltype(auto) sequence() &&
The "sequence", usually a range of nucleotides or amino acids.
Definition: record.hpp:78
~sequence_record()=default
Defaulted.
sequence_record & operator=(sequence_record const &)=default
Defaulted.
decltype(auto) base_qualities() &&
The qualities, usually in Phred score notation.
Definition: record.hpp:99
sequence_record & operator=(sequence_record &&)=default
Defaulted.
decltype(auto) sequence() &
The "sequence", usually a range of nucleotides or amino acids.
Definition: record.hpp:88
decltype(auto) base_qualities() const &
The qualities, usually in Phred score notation.
Definition: record.hpp:114
sequence_record(sequence_record &&)=default
Defaulted.
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
SeqAn specific customisations in the standard namespace.
Provides the seqan3::record template and the seqan3::field enum.
The class template that file records are based on; behaves like a std::tuple.
Definition: record.hpp:191
detail::transfer_template_args_onto_t< field_types, std::tuple > base_type
A specialisation of std::tuple.
Definition: record.hpp:215