Software.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: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/CVTermList.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <functional>
 
namespace OpenMS
{
  class OPENMS_DLLAPI Software :
    public CVTermList
  {
public:
    explicit Software(const std::string& name = "", const std::string& version = "");
    Software(const Software&) = default;
    Software(Software&&) = default;
    ~Software() override;
 
    Software& operator=(const Software&) = default;
    Software& operator=(Software&&)& = default;
 
    bool operator==(const Software& rhs) const;
    bool operator!=(const Software& rhs) const;
    bool operator<(const Software& rhs) const;
 
    const std::string& getName() const;
    void setName(const std::string& name);
 
    const std::string& getVersion() const;
    void setVersion(const std::string& version);
 
protected:
    std::string name_;
    std::string version_;
  };
} // namespace OpenMS
 
// Hash function specialization for Software
namespace std
{
  template<>
  struct hash<OpenMS::Software>
  {
    std::size_t operator()(const OpenMS::Software& s) const noexcept
    {
      std::size_t seed = OpenMS::fnv1a_hash_string(s.getName());
      OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(s.getVersion()));
      return seed;
    }
  };
} // namespace std