Unknown.cpp

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
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#include "pde/common/Unknown.hpp"
 
Unknown::Unknown(
  const CepsUnknownIndex& identifier, 
  const CepsString&       name, 
  const CepsString&       unit
) :
    m_identifier   (identifier),
    m_name         (name),
    m_unit         (unit),
    m_location     (CepsLocationFlag::Point),
    m_interactsWith({})
{
}
 
Unknown::Unknown(const Unknown& that) :
    m_identifier   (that.m_identifier),
    m_name         (that.m_name),
    m_unit         (that.m_unit),
    m_location     (that.m_location),
    m_interactsWith({})
{
}
 
Unknown&
Unknown::operator=(const Unknown& that)
{
  if (ceps::isDifferentPtr(this, &that))
  {
    m_identifier    = that.m_identifier;
    m_name          = that.m_name;
    m_unit          = that.m_unit;
    m_location      = that.m_location;
    m_interactsWith = that.m_interactsWith;
  }
  return *this;
}
 
const CepsString&
Unknown::getName() const
{
  return m_name;
}
 
void
Unknown::setName(const CepsString& name)
{
  m_name = name;
  return;
}
 
CepsUnknownIndex
Unknown::getIdentifier() const
{
  return m_identifier;
}
 
const CepsString&
Unknown::getUnit() const
{
  return m_unit;
}
 
void
Unknown::setUnit(const CepsString& unit)
{
  m_unit = unit;
  return;
}
 
const CepsLocationFlag&
Unknown::getLocation() const
{
  return m_location;
}
 
CepsBool
Unknown::isOnLocation(const CepsLocationFlag& flag) const
{
  return m_location == flag;
}
 
void
Unknown::setLocation(const CepsLocationFlag& location)
{
  m_location = location;
  return;
}
 
CepsBool
Unknown::isSpatial() const
{
  return m_location != CepsLocationFlag::ZeroD;
}
 
void
Unknown::addUnknownInteraction(Unknown* u, CepsBool addReciprocal)
{
  CEPS_ABORT_IF(ceps::isNullPtr(u),
    "Cannot add interaction with nullptr"
  );
  m_interactsWith.insert(u);
  if (addReciprocal)
    u->addUnknownInteraction(this,false);
}
 
CepsBool
Unknown::interactsWith(Unknown* u) const
{
  return u==this or m_interactsWith.contains(u);
}
 
const CepsSet<Unknown*>&
Unknown::getUnknownsInInteraction() const
{
  return m_interactsWith;
}