ModificationDefinition.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: $
// --------------------------------------------------------------------------
//
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CHEMISTRY/ResidueModification.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI ModificationDefinition
  {
public:
 
    ModificationDefinition();
 
    ModificationDefinition(const ModificationDefinition& rhs);
 
    explicit ModificationDefinition(const String& mod, bool fixed = true, UInt max_occur = 0);
 
    explicit ModificationDefinition(const ResidueModification& mod, bool fixed = true, UInt max_occur = 0);
 
    virtual ~ModificationDefinition();
 
    void setFixedModification(bool fixed);
 
    bool isFixedModification() const;
 
    void setMaxOccurrences(UInt num);
 
    UInt getMaxOccurrences() const;
 
    String getModificationName() const;
 
    void setModification(const String& modification);
 
    const ResidueModification& getModification() const;
 
    ModificationDefinition& operator=(const ModificationDefinition& element);
 
    bool operator==(const ModificationDefinition& rhs) const;
 
    bool operator!=(const ModificationDefinition& rhs) const;
 
    bool operator<(const OpenMS::ModificationDefinition&) const;
 
protected:
 
    const ResidueModification* mod_;
 
    bool fixed_modification_;
 
    UInt max_occurrences_;
  };
 
} // namespace OpenMS