SeqAn3  3.0.1
The Modern C++ library for sequence analysis.
record.hpp File Reference

Provides the seqan3::record template and the seqan3::field enum. More...

#include <tuple>
#include <meta/meta.hpp>
#include <seqan3/core/type_list/type_list.hpp>
#include <seqan3/core/type_traits/template_inspection.hpp>
+ Include dependency graph for record.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  seqan3::fields< fs >
 A class template that holds a choice of seqan3::field. More...
 
struct  seqan3::record< field_types, field_ids >
 The class template that file records are based on; behaves like an std::tuple. More...
 
struct  std::tuple_element< elem_no, seqan3::record< field_types, field_ids > >
 Obtains the type of the specified element. More...
 
struct  std::tuple_size< seqan3::record< field_types, field_ids > >
 Provides access to the number of elements in a tuple as a compile-time constant expression. More...
 

Namespaces

 seqan3
 The main SeqAn3 namespace.
 
 std
 SeqAn specific customisations in the standard namespace.
 

Enumerations

enum  seqan3::field {
  seqan3::field::seq, seqan3::field::id, seqan3::field::qual, seqan3::field::seq_qual,
  seqan3::field::offset, seqan3::field::bpp, seqan3::field::structure, seqan3::field::structured_seq,
  seqan3::field::energy, seqan3::field::react, seqan3::field::react_err, seqan3::field::comment,
  seqan3::field::alignment, seqan3::field::ref_id, seqan3::field::ref_seq, seqan3::field::ref_offset,
  seqan3::field::header_ptr, seqan3::field::flag, seqan3::field::mate, seqan3::field::mapq,
  seqan3::field::cigar, seqan3::field::tags, seqan3::field::bit_score, seqan3::field::evalue,
  seqan3::field::user_defined_0, seqan3::field::user_defined_1, seqan3::field::user_defined_2, seqan3::field::user_defined_3,
  seqan3::field::user_defined_4, seqan3::field::user_defined_5, seqan3::field::user_defined_6, seqan3::field::user_defined_7,
  seqan3::field::user_defined_8, seqan3::field::user_defined_9, seqan3::field::SEQ = seq, seqan3::field::ID = id,
  seqan3::field::QUAL = qual, seqan3::field::SEQ_QUAL = seq_qual, seqan3::field::OFFSET = offset, seqan3::field::BPP = bpp,
  seqan3::field::STRUCTURE = structure, seqan3::field::STRUCTURED_SEQ = structured_seq, seqan3::field::ENERGY = energy, seqan3::field::REACT = react,
  seqan3::field::REACT_ERR = react_err, seqan3::field::COMMENT = comment, seqan3::field::ALIGNMENT = alignment, seqan3::field::REF_ID = ref_id,
  seqan3::field::REF_SEQ = ref_seq, seqan3::field::REF_OFFSET = ref_offset, seqan3::field::HEADER_PTR = header_ptr, seqan3::field::FLAG = flag,
  seqan3::field::MATE = mate, seqan3::field::MAPQ = mapq, seqan3::field::CIGAR = cigar, seqan3::field::TAGS = tags,
  seqan3::field::BIT_SCORE = bit_score, seqan3::field::EVALUE = evalue, seqan3::field::USER_DEFINED_0 = user_defined_0, seqan3::field::USER_DEFINED_1 = user_defined_1,
  seqan3::field::USER_DEFINED_2 = user_defined_2, seqan3::field::USER_DEFINED_3 = user_defined_3, seqan3::field::USER_DEFINED_4 = user_defined_4, seqan3::field::USER_DEFINED_5 = user_defined_5,
  seqan3::field::USER_DEFINED_6 = user_defined_6, seqan3::field::USER_DEFINED_7 = user_defined_7, seqan3::field::USER_DEFINED_8 = user_defined_8, seqan3::field::USER_DEFINED_9 = user_defined_9
}
 An enumerator for the fields used in file formats. More...
 

Detailed Description

Provides the seqan3::record template and the seqan3::field enum.

Author
Hannes Hauswedell <hannes.hauswedell AT fu-berlin.de>