DigestionEnzymeProtein.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: Xiao Liang $
// $Authors: Xiao Liang $
// --------------------------------------------------------------------------
//
 
#pragma once
 
#include <OpenMS/CHEMISTRY/DigestionEnzyme.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI DigestionEnzymeProtein :
    public DigestionEnzyme
  {
  public:
 
 
    DigestionEnzymeProtein();
 
    explicit DigestionEnzymeProtein(const DigestionEnzyme& d);
 
    DigestionEnzymeProtein(const DigestionEnzymeProtein&) = default;
 
    DigestionEnzymeProtein(DigestionEnzymeProtein&&) = default;
 
    explicit DigestionEnzymeProtein(const std::string& name,
                                    const std::string& cleavage_regex,
                                    const std::set<std::string>& synonyms = std::set<std::string>(),
                                    std::string regex_description = "",
                                    EmpiricalFormula n_term_gain = EmpiricalFormula("H"),
                                    EmpiricalFormula c_term_gain = EmpiricalFormula("OH"),
                                    std::string psi_id = "",
                                    std::string xtandem_id = "",
                                    Int comet_id = -1,
                                    Int msgf_id = -1,
                                    Int omssa_id = -1);
 
    ~DigestionEnzymeProtein() override;
 
    DigestionEnzymeProtein& operator=(const DigestionEnzymeProtein&) = default;
 
    DigestionEnzymeProtein& operator=(DigestionEnzymeProtein&&) & = default;
 
    void setNTermGain(const EmpiricalFormula& value);
 
    EmpiricalFormula getNTermGain() const;
 
    void setCTermGain(const EmpiricalFormula& value);
 
    EmpiricalFormula getCTermGain() const;
 
    void setPSIID(const std::string& value);
 
    std::string getPSIID() const;
 
    void setXTandemID(const std::string& value);
 
    std::string getXTandemID() const;
 
    void setCometID(Int value);
 
    Int getCometID() const;
 
    void setMSGFID(Int value);
 
    Int getMSGFID() const;
 
    void setOMSSAID(Int value);
 
    Int getOMSSAID() const;
 
 
    bool operator==(const DigestionEnzymeProtein& enzyme) const;
 
    bool operator!=(const DigestionEnzymeProtein& enzyme) const;
 
    // Note: comparison operator is not inherited. TODO rename and make virtual
    bool operator==(const std::string& cleavage_regex) const;
 
    bool operator!=(const std::string& cleavage_regex) const;
 
    bool operator<(const DigestionEnzymeProtein& enzyme) const;
 
    bool setValueFromFile(const std::string& key, const std::string& value) override;
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const DigestionEnzymeProtein& enzyme);
 
  protected:
    EmpiricalFormula n_term_gain_;
 
    EmpiricalFormula c_term_gain_;
 
    std::string psi_id_;
 
    std::string xtandem_id_;
 
    Int comet_id_;
 
    Int msgf_id_;
 
    Int omssa_id_;
 
  };
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const DigestionEnzymeProtein& enzyme);
 
  typedef DigestionEnzymeProtein Protease;
}