structure_file/record.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <seqan3/io/record.hpp>
 
namespace seqan3
{
template <typename field_types, typename field_ids>
class structure_record : public record<field_types, field_ids>
{
    using base_t = record<field_types, field_ids>;
 
    using tuple_base_t = typename base_t::base_type;
 
    template <field f>
    using field_constant = typename base_t::template field_constant<f>;
 
    using base_t::get_impl;
 
public:
    structure_record() = default;                                     
    structure_record(structure_record const &) = default;             
    structure_record & operator=(structure_record const &) = default; 
    structure_record(structure_record &&) = default;                  
    structure_record & operator=(structure_record &&) = default;      
    ~structure_record() = default;                                    
 
    using base_t::base_t;
 
    decltype(auto) id() &&
    {
        return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t &&>(*this));
    }
    decltype(auto) id() const &&
    {
        return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t const &&>(*this));
    }
    decltype(auto) id() &
    {
        return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t &>(*this));
    }
    decltype(auto) id() const &
    {
        return get_impl(field_constant<seqan3::field::id>{}, static_cast<tuple_base_t const &>(*this));
    }
 
    decltype(auto) sequence() &&
    {
        return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t &&>(*this));
    }
    decltype(auto) sequence() const &&
    {
        return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t const &&>(*this));
    }
    decltype(auto) sequence() &
    {
        return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t &>(*this));
    }
    decltype(auto) sequence() const &
    {
        return get_impl(field_constant<seqan3::field::seq>{}, static_cast<tuple_base_t const &>(*this));
    }
 
    decltype(auto) sequence_structure() &&
    {
        return get_impl(field_constant<seqan3::field::structure>{}, static_cast<tuple_base_t &&>(*this));
    }
    decltype(auto) sequence_structure() const &&
    {
        return get_impl(field_constant<seqan3::field::structure>{}, static_cast<tuple_base_t const &&>(*this));
    }
    decltype(auto) sequence_structure() &
    {
        return get_impl(field_constant<seqan3::field::structure>{}, static_cast<tuple_base_t &>(*this));
    }
    decltype(auto) sequence_structure() const &
    {
        return get_impl(field_constant<seqan3::field::structure>{}, static_cast<tuple_base_t const &>(*this));
    }
 
    decltype(auto) energy() &&
    {
        return get_impl(field_constant<seqan3::field::energy>{}, static_cast<tuple_base_t &&>(*this));
    }
    decltype(auto) energy() const &&
    {
        return get_impl(field_constant<seqan3::field::energy>{}, static_cast<tuple_base_t const &&>(*this));
    }
    decltype(auto) energy() &
    {
        return get_impl(field_constant<seqan3::field::energy>{}, static_cast<tuple_base_t &>(*this));
    }
    decltype(auto) energy() const &
    {
        return get_impl(field_constant<seqan3::field::energy>{}, static_cast<tuple_base_t const &>(*this));
    }
 
    decltype(auto) base_pair_probability_matrix() &&
    {
        // this is computed
        return get_impl(field_constant<seqan3::field::bpp>{}, static_cast<tuple_base_t &&>(*this));
    }
    decltype(auto) base_pair_probability_matrix() const &&
    {
        return get_impl(field_constant<seqan3::field::bpp>{}, static_cast<tuple_base_t const &&>(*this));
    }
    decltype(auto) base_pair_probability_matrix() &
    {
        return get_impl(field_constant<seqan3::field::bpp>{}, static_cast<tuple_base_t &>(*this));
    }
    decltype(auto) base_pair_probability_matrix() const &
    {
        return get_impl(field_constant<seqan3::field::bpp>{}, static_cast<tuple_base_t const &>(*this));
    }
 
    // decltype(auto) reactivity(); // unused
    // decltype(auto) reactivity_errors(); // unused
    // decltype(auto) comment(); // unused
    // decltype(auto) base_qualities(); // unused
};
} // namespace seqan3
 
namespace std
{
 
template <typename field_types, typename field_ids>
struct tuple_size<seqan3::structure_record<field_types, field_ids>> :
    tuple_size<typename seqan3::structure_record<field_types, field_ids>::base_type>
{};
 
template <size_t elem_no, typename field_types, typename field_ids>
struct tuple_element<elem_no, seqan3::structure_record<field_types, field_ids>> :
    tuple_element<elem_no, typename seqan3::structure_record<field_types, field_ids>::base_type>
{};
 
} // namespace std