PRM.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_PRM_H
#define GUM_PRM_H
 
#include <string>
 
#include <agrum/PRM/elements/PRMFuncAttribute.h>
#include <agrum/PRM/elements/PRMSystem.h>
 
namespace gum {
  namespace prm {
 
    template < typename GUM_SCALAR >
    class PRMSystem;
    template < typename GUM_SCALAR >
    class PRMFactory;

    template < typename GUM_SCALAR >
    class PRM {
      public:
      friend class PRMFactory< GUM_SCALAR >;
 
      // ========================================================================
      // ========================================================================

      PRM();

      ~PRM();

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

      bool isType(const std::string& name) const;

      bool isClass(const std::string& name) const;

      bool isInterface(const std::string& name) const;

      bool isSystem(const std::string& name) const;

      PRMType& type(const std::string& name);

      const PRMType& type(const std::string& name) const;

      const Set< PRMType* >& types() const;

      PRMClass< GUM_SCALAR >& getClass(const std::string& name);

      const PRMClass< GUM_SCALAR >& getClass(const std::string& name) const;

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

      PRMInterface< GUM_SCALAR >& getInterface(const std::string& name);

      const PRMInterface< GUM_SCALAR >& getInterface(const std::string& name) const;

      const Set< PRMInterface< GUM_SCALAR >* >& interfaces() const;

      PRMSystem< GUM_SCALAR >& getSystem(const std::string& name);

      const PRMSystem< GUM_SCALAR >& getSystem(const std::string& name) const;

      const Set< PRMSystem< GUM_SCALAR >* >& systems() const;

 
      private:
      // ========================================================================
      // ========================================================================

      PRM(const PRM< GUM_SCALAR >& source);

      PRM< GUM_SCALAR >& operator=(const PRM< GUM_SCALAR >& source);

      void _addBuiltInTypes_();

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

      HashTable< std::string, PRMClass< GUM_SCALAR >* > _classMap_;

      Set< PRMClass< GUM_SCALAR >* > _classes_;

      HashTable< std::string, PRMInterface< GUM_SCALAR >* > _interfaceMap_;

      Set< PRMInterface< GUM_SCALAR >* > _interfaces_;

      HashTable< std::string, PRMType* > _typeMap_;

      Set< PRMType* > _types_;

      HashTable< std::string, PRMSystem< GUM_SCALAR >* > _systemMap_;

      Set< PRMSystem< GUM_SCALAR >* > _systems_;

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRM< double >;
#endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/PRM_tpl.h>
 
#endif /* GUM_PRM_H */