HoldsBoundary.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 HoldsBoundary
  {
 
    public:
 
      explicit HoldsBoundary(const CepsBool& isBoundary);
 
      HoldsBoundary() = default;
 
      HoldsBoundary(const HoldsBoundary&) = default;
 
      HoldsBoundary(HoldsBoundary&&) noexcept = default;
 
      virtual ~HoldsBoundary() = default;
 
      HoldsBoundary&
      operator=(const HoldsBoundary&) = default;
 
      HoldsBoundary&
      operator=(HoldsBoundary&&) noexcept = default;
 
      CepsBool
      isBoundary() const;
 
      void
      setOnBoundary(CepsBool value=true);
 
      void
      reset();
 
 
    private:
 
      CepsBool m_isBoundary;
  };
  
}  // namespace ceps