PRMClassElement_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

#include <agrum/PRM/elements/PRMClassElement.h>
#include <agrum/PRM/elements/PRMType.h>
 
namespace gum {
  namespace prm {
 
    template < GUM_Numeric GUM_SCALAR >
    PRMClassElement< GUM_SCALAR >::PRMClassElement(std::string_view name) : PRMObject(name) {
      GUM_CONSTRUCTOR(PRMClassElement);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    PRMClassElement< GUM_SCALAR >::PRMClassElement(const PRMClassElement< GUM_SCALAR >& source) :
        PRMObject(source.name()), _id_(source.id()) {
      GUM_CONS_CPY(PRMClassElement);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    PRMClassElement< GUM_SCALAR >::~PRMClassElement() {
      GUM_DESTRUCTOR(PRMClassElement);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    NodeId PRMClassElement< GUM_SCALAR >::id() const {
      return _id_;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    PRMObject::prm_type PRMClassElement< GUM_SCALAR >::obj_type() const {
      return prm_type::CLASS_ELT;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    void PRMClassElement< GUM_SCALAR >::setId(NodeId id) {
      _id_ = id;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    const std::string& PRMClassElement< GUM_SCALAR >::safeName() const {
      return safeName_;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    std::string PRMClassElement< GUM_SCALAR >::cast(const PRMType& t) const {
      if (type().isSubTypeOf(t)) {
        return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST() + name();
      } else {
        GUM_ERROR(OperationNotAllowed, "illegal cast")
      }
    }
 
    template < GUM_Numeric GUM_SCALAR >
    std::string PRMClassElement< GUM_SCALAR >::enum2str(ClassElementType type) {
      switch (type) {
        case prm_attribute : return "prm_attribute";
 
        case prm_aggregate : return "prm_aggregate";
 
        case prm_refslot : return "prm_refslot";
 
        case prm_slotchain : return "prm_slotchain";
 
        case prm_parameter : return "prm_parameter";
 
        default : return "unknown";
      }
    }
 
    template < GUM_Numeric GUM_SCALAR >
    bool PRMClassElement< GUM_SCALAR >::isReferenceSlot(const PRMClassElement< GUM_SCALAR >& elt) {
      return elt.elt_type() == prm_refslot;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    bool PRMClassElement< GUM_SCALAR >::isAttribute(const PRMClassElement< GUM_SCALAR >& elt) {
      return elt.elt_type() == prm_attribute;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    bool PRMClassElement< GUM_SCALAR >::isAggregate(const PRMClassElement< GUM_SCALAR >& elt) {
      return elt.elt_type() == prm_aggregate;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    bool PRMClassElement< GUM_SCALAR >::isSlotChain(const PRMClassElement< GUM_SCALAR >& elt) {
      return elt.elt_type() == prm_slotchain;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    bool PRMClassElement< GUM_SCALAR >::isParameter(const PRMClassElement< GUM_SCALAR >& elt) {
      return elt.elt_type() == prm_parameter;
    }
 
  } /* namespace prm */
} /* namespace gum */