PRMInterface.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_INTERFACE_H
#define GUM_INTERFACE_H
 
#include <set>
#include <string>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/PRM/elements/PRMReferenceSlot.h>
#include <agrum/PRM/elements/PRMScalarAttribute.h>
 
namespace gum {
  namespace prm {
 
    template < typename GUM_SCALAR >
    class PRMClass;

    template < typename GUM_SCALAR >
    class PRMInterface: public PRMClassElementContainer< GUM_SCALAR > {
      // ========================================================================
      friend class PRMClass< GUM_SCALAR >;
      // ========================================================================
 
      public:
      // ========================================================================
      // ========================================================================

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

      PRMInterface(const std::string&          name,
                   PRMInterface< GUM_SCALAR >& super,
                   bool                        delayInheritance = false);

      PRMInterface(const PRMInterface< GUM_SCALAR >& source);

      virtual ~PRMInterface();

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

      virtual typename PRMObject::prm_type obj_type() const;

      virtual PRMClassElement< GUM_SCALAR >& get(NodeId id);

      virtual const PRMClassElement< GUM_SCALAR >& get(NodeId id) const;

      void addArc(const std::string& tail, const std::string& head);

      // ========================================================================
      // ========================================================================
 
      virtual bool isOutputNode(const PRMClassElement< GUM_SCALAR >& elt) const;

      virtual PRMClassElement< GUM_SCALAR >& get(const std::string& name);

      virtual const PRMClassElement< GUM_SCALAR >& get(const std::string& name) const;

      const Set< PRMAttribute< GUM_SCALAR >* >& attributes() const;

      const Set< PRMReferenceSlot< GUM_SCALAR >* >& referenceSlots() const;

      NodeId add(PRMClassElement< GUM_SCALAR >* elt);

      NodeId overload(PRMClassElement< GUM_SCALAR >* elt);

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

      virtual bool isSubTypeOf(const PRMClassElementContainer< GUM_SCALAR >& cec) const;

      PRMInterface< GUM_SCALAR >& super();

      const PRMInterface< GUM_SCALAR >& super() const;

      Set< PRMClass< GUM_SCALAR >* >& implementations();

      const Set< PRMClass< GUM_SCALAR >* >& implementations() const;

      void inheritInterface();

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

      PRMClassElement< GUM_SCALAR >& operator[](NodeId id);

      const PRMClassElement< GUM_SCALAR >& operator[](NodeId id) const;

      PRMClassElement< GUM_SCALAR >& operator[](const std::string& name);

      const PRMClassElement< GUM_SCALAR >& operator[](const std::string& name) const;

      // ========================================================================
      // ========================================================================
 
      using ClassEltIterator = typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::iterator;
      ClassEltIterator        begin();
      const ClassEltIterator& end();
 
      using const_ClassEltIterator =
          typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::const_iterator;
      const_ClassEltIterator        begin() const;
      const const_ClassEltIterator& end() const;

 
      protected:
      const DAG& dag_() const;

      DAG& dag_();

      void findAllSubtypes_(Set< PRMClassElementContainer< GUM_SCALAR >* >& set);

      void updateDescendants_(const PRMClassElement< GUM_SCALAR >& elt);
 
      private:
      PRMInterface< GUM_SCALAR >& operator=(const PRMInterface< GUM_SCALAR >& source);

      void _inheritInterface_(const PRMInterface< GUM_SCALAR >& i);
 
      // ========================================================================
      // ========================================================================

      DAG _dag_;

      NodeProperty< PRMClassElement< GUM_SCALAR >* > _nodeIdMap_;

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

      HashTable< std::string, PRMClassElement< GUM_SCALAR >* > _nameMap_;

      Set< PRMAttribute< GUM_SCALAR >* > _attributes_;

      Set< PRMReferenceSlot< GUM_SCALAR >* > _referenceSlots_;

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

      PRMInterface< GUM_SCALAR >* _superInterface_;

      Set< PRMClass< GUM_SCALAR >* > _implementations_;

      void _addImplementation_(PRMClass< GUM_SCALAR >* c);

      Set< PRMInterface< GUM_SCALAR >* > _extensions_;

      void _addExtension_(PRMInterface< GUM_SCALAR >* c);
 
      bool _checkOverloadLegality_(const PRMClassElement< GUM_SCALAR >* overloaded,
                                   const PRMClassElement< GUM_SCALAR >* overloader);
 
      void _overloadAttribute_(PRMAttribute< GUM_SCALAR >* overloader,
                               PRMAttribute< GUM_SCALAR >* overloaded);
 
      void _overloadReferenceSlot_(PRMReferenceSlot< GUM_SCALAR >* overloader,
                                   PRMReferenceSlot< GUM_SCALAR >* overloaded);
 
      void _addCastDescendants_(PRMAttribute< GUM_SCALAR >* start, PRMAttribute< GUM_SCALAR >* end);

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMInterface< double >;
#endif
 
 
  } /* namespace prm */
}   // namespace gum
 
#include <agrum/PRM/elements/PRMInterface_tpl.h>
 
#endif /* GUM_INTERFACE_H */