Ribonucleotide.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Hendrik Weisser $
// $Authors: Hendrik Weisser $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CHEMISTRY/EmpiricalFormula.h>
#include <iosfwd>
 
namespace OpenMS
{
  class OPENMS_DLLAPI Ribonucleotide
  {
    friend class RibonucleotideDB;
  public:
 
    enum TermSpecificityNuc
    {
      ANYWHERE,
      FIVE_PRIME,
      THREE_PRIME,
      NUMBER_OF_TERM_SPECIFICITY
    };
 
    Ribonucleotide(const String& name = "unknown ribonucleotide",
                   const String& code = ".",
                   const String& new_code = "",
                   const String& html_code = ".",
                   const EmpiricalFormula& formula = EmpiricalFormula(),
                   char origin = '.',
                   double mono_mass = 0.0,
                   double avg_mass = 0.0,
                   enum TermSpecificityNuc term_spec = ANYWHERE,
                   const EmpiricalFormula& baseloss_formula =
                   default_baseloss_);
 
    Ribonucleotide(const Ribonucleotide& ribo) = default;
 
    virtual ~Ribonucleotide();
 
    Ribonucleotide& operator=(const Ribonucleotide& ribo) = default;
 
 
    bool operator==(const Ribonucleotide& ribonucleotide) const;
 
 
    const String getCode() const;
 
    void setCode(const String& code);
 
    const String getName() const;
 
    void setName(const String& name);
 
    const EmpiricalFormula getFormula() const;
 
    void setFormula(const EmpiricalFormula& formula);
 
    double getMonoMass() const;
 
    void setMonoMass(double mono_mass);
 
    double getAvgMass() const;
 
    void setAvgMass(double avg_mass);
 
    const String getNewCode() const;
 
    void setNewCode(const String &new_code);
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Ribonucleotide& ribo);
 
    char getOrigin() const;
 
    void setOrigin(char origin);
 
    String getHTMLCode() const;
 
    void setHTMLCode(const String& html_code);
 
    enum TermSpecificityNuc getTermSpecificity() const;
 
    void setTermSpecificity(enum TermSpecificityNuc term_spec);
 
    const EmpiricalFormula getBaselossFormula() const;
 
    void setBaselossFormula(const EmpiricalFormula& formula);
 
 
    bool isModified() const;
 
    bool isAmbiguous() const;
 
  protected:
    static const EmpiricalFormula default_baseloss_;
 
    String name_; 
    String code_; 
    String new_code_; 
    String html_code_; 
    EmpiricalFormula formula_; 
    char origin_; 
    double mono_mass_; 
    double avg_mass_; 
    enum TermSpecificityNuc term_spec_; 
    EmpiricalFormula baseloss_formula_; 
  };
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Ribonucleotide& ribo);
 
  using RibonucleotideChainEnd = Ribonucleotide;
 
}