HoldsProcIds.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/core/CepsTypes.hpp"
 
namespace ceps
{
  class HoldsProcIds
  {
 
    public:
 
      explicit HoldsProcIds(const CepsProcId& owner, const CepsVector<CepsProcId>& halosPid = {});
 
      HoldsProcIds() = default;
  
      HoldsProcIds(const HoldsProcIds&) = default;
  
      HoldsProcIds(HoldsProcIds&&) noexcept = default;
  
      virtual ~HoldsProcIds() = default;
 
      HoldsProcIds&
      operator=(const HoldsProcIds&) = default;
  
      HoldsProcIds&
      operator=(HoldsProcIds&&) noexcept = default;
 
      CepsBool
      isShared() const;
  
      void
      setShared(CepsBool flag);
  
      void
      setOwner(const CepsProcId& pid);
  
      const CepsProcId&
      getOwner() const;
 
      void
      setAsHaloFor(const CepsProcId& pid);
  
      CepsBool
      isHaloFor(const CepsProcId& pid) const;
  
      void
      reset();
 
 
    private:
 
      CepsVector<CepsProcId> m_procIds;
 
      CepsBool m_isShared;
 
  };
 
}  // namespace ceps