CVTerm.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/DATASTRUCTURES/String.h>
#include <OpenMS/DATASTRUCTURES/DataValue.h>
#include <OpenMS/CONCEPT/HashUtils.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI CVTerm
  {
public:
 
    struct Unit
    {
 
      Unit() = default;
 
      Unit(const String& p_accession, const String& p_name, const String& p_cv_ref) :
        accession(p_accession),
        name(p_name),
        cv_ref(p_cv_ref)
      {
      }
 
      Unit(const Unit &) = default;
 
      Unit(Unit&&) = default;
 
      virtual ~Unit()
      {
      }
 
      Unit& operator=(const Unit&) = default;
 
      Unit& operator=(Unit&&)& = default;
 
      bool operator==(const Unit& rhs) const
      {
        return accession == rhs.accession &&
               name == rhs.name &&
               cv_ref == rhs.cv_ref;
      }
 
      bool operator!=(const Unit& rhs) const
      {
        return !(*this == rhs);
      }
 
      String accession;
      String name;
      String cv_ref;
    };
 
    CVTerm() = default;
 
    CVTerm(const String& accession, const String& name = "", const String& cv_identifier_ref = "", const String& value = "", const Unit& unit = Unit());
 
    CVTerm(const CVTerm&) = default;
 
    CVTerm(CVTerm&&) = default;
 
    virtual ~CVTerm();
 
    CVTerm& operator=(const CVTerm&) = default;
 
    CVTerm& operator=(CVTerm&&)& = default;
 
    void setAccession(const String& accession);
 
    const String& getAccession() const;
 
    void setName(const String& name);
 
    const String& getName() const;
 
    void setCVIdentifierRef(const String& cv_identifier_ref);
 
    const String& getCVIdentifierRef() const;
 
    void setValue(const DataValue& value);
 
    const DataValue& getValue() const;
 
    void setUnit(const Unit& unit);
 
    const Unit& getUnit() const;
 
    bool operator==(const CVTerm& rhs) const;
 
    bool operator!=(const CVTerm& rhs) const;
 
    bool hasValue() const;
 
    bool hasUnit() const;
    //}
 
protected:
 
    String accession_;
 
    String name_;
 
    String cv_identifier_ref_;
 
    Unit unit_;
 
    DataValue value_;
  };
 
} // namespace OpenMS
 
// Hash function specializations for CVTerm and CVTerm::Unit
namespace std
{
  template<>
  struct hash<OpenMS::CVTerm::Unit>
  {
    std::size_t operator()(const OpenMS::CVTerm::Unit& unit) const noexcept
    {
      std::size_t seed = 0;
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(unit.accession));
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(unit.name));
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(unit.cv_ref));
      return seed;
    }
  };
 
  template<>
  struct hash<OpenMS::CVTerm>
  {
    std::size_t operator()(const OpenMS::CVTerm& term) const noexcept
    {
      std::size_t seed = 0;
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(term.getAccession()));
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(term.getName()));
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(term.getCVIdentifierRef()));
      OpenMS::hash_combine(seed, std::hash<OpenMS::CVTerm::Unit>{}(term.getUnit()));
      OpenMS::hash_combine(seed, std::hash<OpenMS::DataValue>{}(term.getValue()));
      return seed;
    }
  };
} // namespace std