CVTermListInterface.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: Hannes Roest $
// $Authors: Hannes Roest $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/CVTerm.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <map>
 
namespace OpenMS
{
 
  class CVTermList;
 
  class OPENMS_DLLAPI CVTermListInterface :
    public MetaInfoInterface
  {
 
  public:
 
    // Constructor
    CVTermListInterface();
    CVTermListInterface(const CVTermListInterface & rhs);
    CVTermListInterface(CVTermListInterface&&) noexcept;
    // Destructor (non virtual)
    ~CVTermListInterface();
 
    CVTermListInterface & operator=(const CVTermListInterface & rhs);
    CVTermListInterface& operator=(CVTermListInterface&&) noexcept;
 
    bool operator==(const CVTermListInterface& rhs) const;
 
    bool operator!=(const CVTermListInterface& rhs) const;
 
    void replaceCVTerms(std::map<String, std::vector<CVTerm> > & cv_terms);
 
    void setCVTerms(const std::vector<CVTerm>& terms);
 
    void replaceCVTerm(const CVTerm& cv_term);
 
    void replaceCVTerms(const std::vector<CVTerm>& cv_terms, const String& accession);
 
    void replaceCVTerms(const std::map<String, std::vector<CVTerm> >& cv_term_map);
 
    void consumeCVTerms(const std::map<String, std::vector<CVTerm> >& cv_term_map);
 
    const std::map<String, std::vector<CVTerm> >& getCVTerms() const;
 
    void addCVTerm(const CVTerm& term);
 
    bool hasCVTerm(const String& accession) const;
 
    bool empty() const;
 
  private:
 
    void createIfNotExists_(); 
 
    CVTermList* cvt_ptr_;
  };
 
} // namespace OpenMS
 
// Hash function specialization for CVTermListInterface
namespace std
{
  template<>
  struct hash<OpenMS::CVTermListInterface>
  {
    std::size_t operator()(const OpenMS::CVTermListInterface& iface) const noexcept
    {
      std::size_t seed = 0;
      for (const auto& entry : iface.getCVTerms())
      {
        // Hash the accession string
        OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(entry.first));
        // Hash each CV term in the vector
        for (const auto& term : entry.second)
        {
          OpenMS::hash_combine(seed, std::hash<OpenMS::CVTerm>{}(term));
        }
      }
      return seed;
    }
  };
} // namespace std