CVMappingRule.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: Andreas Bertsch $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OpenMSConfig.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <vector>
 
namespace OpenMS
{
  class CVMappingTerm;
 
  class OPENMS_DLLAPI CVMappingRule
  {
public:
 
    enum RequirementLevel
    {
      MUST = 0,
      SHOULD = 1,
      MAY = 2
    };
 
    enum CombinationsLogic
    {
      OR = 0,
      AND = 1,
      XOR = 2
    };
 
    CVMappingRule();
 
    CVMappingRule(const CVMappingRule& rhs);
 
    virtual ~CVMappingRule();
 
    CVMappingRule& operator=(const CVMappingRule& rhs);
 
    void setIdentifier(const String& identifier);
 
    const String& getIdentifier() const;
 
    void setElementPath(const String& element_path);
 
    const String& getElementPath() const;
 
    void setRequirementLevel(RequirementLevel level);
 
    RequirementLevel getRequirementLevel() const;
 
    void setCombinationsLogic(CombinationsLogic combinations_logic);
 
    CombinationsLogic getCombinationsLogic() const;
 
    void setScopePath(const String& path);
 
    const String& getScopePath() const;
 
    void setCVTerms(const std::vector<CVMappingTerm>& cv_terms);
 
    const std::vector<CVMappingTerm>& getCVTerms() const;
 
    void addCVTerm(const CVMappingTerm& cv_terms);
 
    bool operator==(const CVMappingRule& rhs) const;
 
    bool operator!=(const CVMappingRule& rhs) const;
 
protected:
 
    String identifier_;
 
    String element_path_;
 
    RequirementLevel requirement_level_;
 
    String scope_path_;
 
    CombinationsLogic combinations_logic_;
 
    std::vector<CVMappingTerm> cv_terms_;
  };
 
} // namespace OpenMS