RibonucleotideDB.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hendrik Weisser $
// $Authors: Hendrik Weisser $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CHEMISTRY/Ribonucleotide.h>
#include <OpenMS/CHEMISTRY/RibonucleotideDataProvider.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <map>
#include <memory>
#include <unordered_map>
 
namespace OpenMS
{
  class OPENMS_DLLAPI RibonucleotideDB final
  {
  public:
    using ConstRibonucleotidePtr = const Ribonucleotide *;
 
    typedef std::vector<std::unique_ptr<Ribonucleotide>>::const_iterator ConstIterator;
 
    static const RibonucleotideDB* getInstance();
 
    ~RibonucleotideDB() = default;
 
    RibonucleotideDB(const RibonucleotideDB& other) = delete;
 
    RibonucleotideDB& operator=(const RibonucleotideDB& other) = delete;
 
    explicit RibonucleotideDB(std::vector<std::unique_ptr<RibonucleotideDataProvider>> providers);
 
    inline ConstIterator begin() const
    {
      return ribonucleotides_.begin();
    }
 
    inline ConstIterator end() const
    {
      return ribonucleotides_.end();
    }
 
    ConstRibonucleotidePtr getRibonucleotide(const std::string& code) const;
 
    ConstRibonucleotidePtr getRibonucleotidePrefix(const std::string& seq) const;
 
    std::pair<ConstRibonucleotidePtr, ConstRibonucleotidePtr> getRibonucleotideAlternatives(const std::string& code) const;
 
 
  protected:
    RibonucleotideDB();
 
    std::vector<std::unique_ptr<Ribonucleotide>> ribonucleotides_;
 
    std::unordered_map<std::string, Size> code_map_;
 
    std::map<std::string, std::pair<ConstRibonucleotidePtr, ConstRibonucleotidePtr>> ambiguity_map_;
 
    Size max_code_length_;
 
  private:
    void loadFromProviders_(std::vector<std::unique_ptr<RibonucleotideDataProvider>>& providers);
  };
}