UniqueIdInterface.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/DATASTRUCTURES/String.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI UniqueIdInterface
  {
public:
 
    enum
    {
      INVALID = 0
    };
 
    inline static bool
    isValid(UInt64 unique_id)
    {
      return unique_id != INVALID;
    }
 
    UniqueIdInterface() :
      unique_id_(UInt64(INVALID))
    {
      //do not use clearUniqueId(), as it will be slower and creates a warranted valgrind warning;
    }
 
    UniqueIdInterface(const UniqueIdInterface & rhs) = default;
 
    UniqueIdInterface(UniqueIdInterface && rhs) = default;
 
    UniqueIdInterface & operator=(UniqueIdInterface const & rhs) = default;
 
    UniqueIdInterface& operator=(UniqueIdInterface&&) & = default;
 
    virtual ~UniqueIdInterface() = default;
 
    bool
    operator==(UniqueIdInterface const & rhs) const
    {
      return unique_id_ == rhs.unique_id_;
    }
 
    UInt64
    getUniqueId() const
    {
      return unique_id_;
    }
 
    Size
    clearUniqueId()
    {
      if (hasValidUniqueId())
      {
        unique_id_ = 0;
        return 1;
      }
      else
        return 0;
    }
 
    void
    swap(UniqueIdInterface & from)
    {
      std::swap(unique_id_, from.unique_id_);
      return;
    }
 
    Size
    hasValidUniqueId() const
    {
      return isValid(unique_id_);
    }
 
    Size
    hasInvalidUniqueId() const
    {
      return !isValid(unique_id_);
    }
 
    Size
    setUniqueId();
 
    Size
    ensureUniqueId();
 
    void
    setUniqueId(UInt64 rhs)
    {
      unique_id_ = rhs;
    }
 
    void
    setUniqueId(const String & rhs);
 
protected:
    UInt64 unique_id_;
 
  };
 
} //namespace OpenMS