PRMClassElement.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_CLASS_ELEMENT_H
#define GUM_CLASS_ELEMENT_H
 
#include <sstream>
 
#include <agrum/agrum.h>
 
#include <agrum/PRM/utils_prm.h>
 
namespace gum {
  namespace prm {
    template < typename GUM_SCALAR >
    class PRMAttribute;

    template < typename GUM_SCALAR >
    class PRMClassElement: public PRMObject {
      public:
      // ========================================================================
      // ========================================================================

      explicit PRMClassElement(const std::string& name);

      PRMClassElement(const PRMClassElement< GUM_SCALAR >& source);

      virtual ~PRMClassElement();

      // ========================================================================
      // ========================================================================
 
      enum ClassElementType {
        prm_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };
 
      static std::string 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";
        }
      }

      static INLINE bool isReferenceSlot(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_refslot;
      }

      static INLINE bool isAttribute(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_attribute;
      }

      static INLINE bool isAggregate(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_aggregate;
      }

      static INLINE bool isSlotChain(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_slotchain;
      }

      static INLINE bool isParameter(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_parameter;
      }

      // ========================================================================
      // ========================================================================

      NodeId id() const;

      virtual void setId(NodeId id);

      virtual void addParent(const PRMClassElement< GUM_SCALAR >& elt) = 0;

      virtual void addChild(const PRMClassElement< GUM_SCALAR >& elt) = 0;

      virtual typename PRMObject::prm_type obj_type() const;

      virtual ClassElementType elt_type() const = 0;

      // ========================================================================
      // ========================================================================

      virtual PRMType& type() = 0;

      virtual const PRMType& type() const = 0;

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const = 0;

      const std::string& safeName() const;

      virtual std::string cast(const PRMType& t) const;
 
      // /**
      //  * Return a reference over the gum::Tensor of this class element.
      //  * @throw OperationNotAllowed Raised if this class element doesn't have
      //  *                            any gum::Tensor (like a
      //  gum::PRMReferenceSlot).
      //  */
      // virtual Tensor<GUM_SCALAR>& cpf() = 0;

      virtual const Tensor< GUM_SCALAR >& cpf() const = 0;

 
      protected:
      std::string safeName_;
 
      private:
      NodeId _id_;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMClassElement< double >;
#endif
 
  } /* namespace prm */
}   // namespace gum
 
#include <agrum/PRM/elements/PRMClassElement_tpl.h>
 
#endif /* GUM_CLASS_ELEMENT_H */