|
(Note that these are not member functions.)
|
|
This is the tuple interface via seqan3::field, e.g. seqan3::get<seqan3::field::seq>(record) .
|
template<field f, typename field_types , typename field_ids > |
auto & | get (record< field_types, field_ids > &r) |
| Free function get() for seqan3::record based on seqan3::field.
|
|
template<field f, typename field_types , typename field_ids > |
auto const & | get (record< field_types, field_ids > const &r) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
template<field f, typename field_types , typename field_ids > |
auto && | get (record< field_types, field_ids > &&r) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
template<field f, typename field_types , typename field_ids > |
auto const && | get (record< field_types, field_ids > const &&r) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
|
You can expect these (meta-)functions on all types that implement seqan3::tuple_like.
|
size_t | tuple_size_v |
| A unary type trait that holds the number of elements in the tuple. More...
|
|
| tuple_elment_t |
| A transformation trait that holds the type of elements in the tuple. More...
|
|
auto && | get (type &&val) |
| Return the i-th element of the tuple. More...
|
|
template<typename field_types, typename field_ids>
struct seqan3::record< field_types, field_ids >
The class template that file records are based on; behaves like an std::tuple.
- Template Parameters
-
This class template behaves just like an std::tuple, with the exception that it provides an additional get-interface that takes a seqan3::field identifier. The traditional get interfaces (via index and via type) are also supported, but discouraged, because accessing via seqan3::field is unambiguous and better readable.
Example
For input files this template is specialised automatically and provided by the file via its record_type
member. For output files you my define it locally and pass instances of this to the output file's push_back()
.
This is how it works:
int main()
{
using seqan3::operator""_dna4;
record_type my_record{};
get<1>(my_record) = "the most important sequence in the database";
get<seqan3::field::seq>(my_record) = "ACGT"_dna4;
get<std::string>(my_record) = "the least important sequence in the database";
}
Provides seqan3::dna4, container aliases and string literals.
meta::list< types... > type_list
Type that contains multiple types, an alias for meta::list.
Definition: type_list.hpp:31
constexpr auto const & get(configuration< configs_t... > const &config) noexcept
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: configuration.hpp:434
Provides seqan3::phred42 quality scores.
Provides the seqan3::record template and the seqan3::field enum.
A class template that holds a choice of seqan3::field.
Definition: record.hpp:163
The class template that file records are based on; behaves like an std::tuple.
Definition: record.hpp:223
Provides seqan3::type_list.