Unknown.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/CepsCommon.hpp"
 
class Unknown;
 
class Unknown : public ceps::HoldsAttributes
{
  public:
    Unknown () = delete;
 
    explicit Unknown(
      const CepsUnknownIndex& identifier, 
      const CepsString&       name = CepsString(CepsNoName),
      const CepsString&       unit = CepsString(CepsNoUnit));
 
    Unknown(const Unknown&that);
 
    Unknown&
    operator=(const Unknown& that);
 
    CepsUnknownIndex
    getIdentifier() const;
 
    // WARNING: no set identifer because the name must be constant along the exec..
 
    const CepsString&
    getName() const;
 
    void
    setName(const CepsString& name);
 
    const CepsString&
    getUnit() const;
 
    void
    setUnit(const CepsString& unit);
 
    const CepsLocationFlag&
    getLocation() const;
 
    const CepsSet<Unknown*>&
    getUnknownsInInteraction() const;
 
    CepsBool
    isOnLocation(const CepsLocationFlag& flag) const;
 
    void
    setLocation(const CepsLocationFlag& location);
 
    CepsBool
    isSpatial() const;
 
    void
    addUnknownInteraction(Unknown* u, CepsBool addReciprocal = true); 
 
    CepsBool
    interactsWith(Unknown* u) const;
 
  protected:
 
    CepsUnknownIndex  m_identifier;    
    CepsString        m_name;          
    CepsString        m_unit;          
    CepsLocationFlag  m_location;      
    CepsSet<Unknown*> m_interactsWith; 
 
};
 
void
getRegionsIntersectionWith (Unknown const* a, Unknown const* b, CepsSet<CepsAttribute>* regions);
 
class UnknownInteraction : public ceps::HoldsAttributes
{
 
  public:
 
    Unknown* u1; 
    Unknown* u2; 
 
};