SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
seqan3::record< field_types, field_ids > Struct Template Reference

The class template that file records are based on; behaves like an std::tuple. More...

#include <seqan3/io/record.hpp>

+ Inheritance diagram for seqan3::record< field_types, field_ids >:

Public Types

using base_type = detail::transfer_template_args_onto_t< field_types, std::tuple >
 A specialisation of std::tuple.
 

Public Member Functions

void clear () noexcept(noexcept(std::apply(expander, std::declval< record & >())))
 Clears containers that provide .clear() and (re-)initialises all other elements with = {}.
 
Constructors, destructor and assignment
 record ()=default
 Defaulted.
 
 record (record const &)=default
 Defaulted.
 
recordoperator= (record const &)=default
 Defaulted.
 
 record (record &&)=default
 Defaulted.
 
recordoperator= (record &&)=default
 Defaulted.
 
 ~record ()=default
 Defaulted.
 

Related Functions

(Note that these are not member functions.)

Free function get() interface for seqan3::record based on seqan3::field.

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.
 

Detailed Description

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
field_typesThe types of the fields in this record as a seqan3::type_list.
field_idsA seqan3::fields type with seqan3::field IDs corresponding to field_types.

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:

#include <string>
#include <vector>
int main()
{
using namespace seqan3::literals;
using seqan3::get;
// The order of the types below represent a mapping between the type and the key.
// record_type now mimics std::tuple<std::string, dna4_vector, std::vector<phred42>>,
// the order also depends on selected_ids
record_type my_record{};
get<1>(my_record) = "the most important sequence in the database"; // access via index
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
get<seqan3::field::seq>(my_record) = "ACGT"_dna4; // access via seqan3::field
#pragma GCC diagnostic pop
get<std::string>(my_record) = "the least important sequence in the database"; // access via type
}
Provides seqan3::dna4, container aliases and string literals.
The SeqAn namespace for literals.
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:433
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:168
The class template that file records are based on; behaves like an std::tuple.
Definition: record.hpp:228
Type that contains multiple types.
Definition: type_list.hpp:29
Provides seqan3::type_list.

The documentation for this struct was generated from the following file: