RibonucleotideDataProvider.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: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CHEMISTRY/Ribonucleotide.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <memory>
#include <vector>
 
namespace OpenMS
{
  struct OPENMS_DLLAPI RibonucleotideEntry
  {
    std::unique_ptr<Ribonucleotide> ribo;
    String alternative_code_1; 
    String alternative_code_2; 
 
    RibonucleotideEntry() = default;
    ~RibonucleotideEntry() = default;
    RibonucleotideEntry(const RibonucleotideEntry&) = delete;
    RibonucleotideEntry& operator=(const RibonucleotideEntry&) = delete;
    RibonucleotideEntry(RibonucleotideEntry&&) = default;
    RibonucleotideEntry& operator=(RibonucleotideEntry&&) = default;
 
    bool isAmbiguous() const { return !alternative_code_1.empty(); }
  };
 
  class OPENMS_DLLAPI RibonucleotideDataProvider
  {
  public:
    virtual ~RibonucleotideDataProvider() = default;
 
    virtual std::vector<RibonucleotideEntry> loadRibonucleotides() = 0;
  };
 
  class OPENMS_DLLAPI InMemoryRibonucleotideDataProvider : public RibonucleotideDataProvider
  {
  public:
    explicit InMemoryRibonucleotideDataProvider(std::vector<RibonucleotideEntry> entries)
      : entries_(std::move(entries))
    {
    }
 
    InMemoryRibonucleotideDataProvider(const InMemoryRibonucleotideDataProvider&) = delete;
    InMemoryRibonucleotideDataProvider& operator=(const InMemoryRibonucleotideDataProvider&) = delete;
    InMemoryRibonucleotideDataProvider(InMemoryRibonucleotideDataProvider&&) = default;
    InMemoryRibonucleotideDataProvider& operator=(InMemoryRibonucleotideDataProvider&&) = default;
 
    std::vector<RibonucleotideEntry> loadRibonucleotides() override
    {
      return std::move(entries_);
    }
 
  private:
    std::vector<RibonucleotideEntry> entries_;
  };
 
} // namespace OpenMS