HoldsAttributes.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 HoldsAttributes
  {
 
    public:
 
      explicit HoldsAttributes(const CepsSet<CepsAttribute>& attributes);
 
      explicit HoldsAttributes(const CepsVector<CepsAttribute>& attributes);
 
      HoldsAttributes(CepsAttribute* attributes, const CepsUInt& n);
 
      HoldsAttributes() = default;
 
      HoldsAttributes(const HoldsAttributes&) = default;
 
      HoldsAttributes(HoldsAttributes&&) noexcept = default;
 
      virtual ~HoldsAttributes() = default;
 
      HoldsAttributes&
      operator=(const HoldsAttributes&) = default;
 
      HoldsAttributes&
      operator=(HoldsAttributes&&) noexcept = default;
 
      CepsUInt
      getNumberOfAttributes() const;
 
      CepsSet<CepsAttribute>&
      getAttributes();
 
      const CepsSet<CepsAttribute>&
      getAttributes() const;
 
      void
      setAttributes(const CepsVector<CepsAttribute>& attributes);
 
      void
      setAttributes(const CepsSet<CepsAttribute>& attributes);
 
      void
      setAttributes(const CepsAttribute* attributes, const CepsUInt& n);
 
      template <class _It>
      void
      setAttributes(_It first, _It last)
      {
        m_attributes = CepsSet<CepsAttribute>(first, last);
        return;
      }
 
      void
      addAttribute (const CepsAttribute& name);
 
      void
      addAttributes(const CepsVector<CepsAttribute>& attributes);
 
      void
      addAttributes(const CepsSet<CepsAttribute>& attributes);
 
      void
      addAttributes(const CepsAttribute* attributes, const CepsUInt& n);
 
      template <class _It>
      void
      addAttributes(_It first, _It last)
      {
        for (_It it=first; it!=last; ++it)
        {
          auto attr = *it;
          addAttribute(attr);
        }
        return;
      }
 
      void
      removeAttribute(const CepsAttribute& name);
 
      void
      removeAttributes(const CepsSet<CepsAttribute>& attributes);
 
      void
      removeAttributes(const CepsVector<CepsAttribute>& attributes);
 
      void
      removeAttributes(const CepsAttribute* attributes, const CepsUInt &n);
 
      template <class _It>
      void
      removeAttributes(_It first, _It last)
      {
        for (_It it=first; it!=last; ++it)
        {
          auto attr = *it;
          removeAttribute(attr);
        }
        return;
      }
 
      void
      clearAttributes();
 
      CepsBool
      hasAttribute(const CepsAttribute& name) const;
 
      CepsBool
      hasAllAttributes(const CepsVector<CepsAttribute>& attributes) const;
 
      CepsBool
      hasAllAttributes(const CepsAttribute* attributes, const CepsUInt& n) const;
 
      template <class _It>
      CepsBool
      hasAllAttributes(_It first, _It last) const
      {
        for (_It it=first; it!=last; ++it)
        {
          auto attr = *it;
          if (not hasAttribute(attr))
            return false;
        }
        return true;
      }
 
      CepsBool
      hasOneOfAttributes(const CepsSet<CepsAttribute>& attributes) const;
 
      CepsBool
      hasOneOfAttributes (const CepsVector<CepsAttribute>& attributes) const;
 
      CepsBool
      hasOneOfAttributes(const CepsAttribute* attributes, const CepsUInt& n) const;
 
      template <class _It>
      CepsBool
      hasOneOfAttributes(_It first, _It last) const
      {
        for (_It it=first; it!=last; ++it)
        {
          auto attr = *it;
          if (hasAttribute(attr))
            return true;
        }
        return false;
      }
 
      CepsBool
      hasUniversalAttribute() const;
 
      void
      reset();
 
 
    protected:
 
      CepsSet<CepsAttribute> m_attributes;
 
  };
  
}  // namespace ceps