PRMObject.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_OBJECT_H
#define GUM_PRM_OBJECT_H
 
#include <string>
 
#include <agrum/agrum.h>
 
namespace gum {
 
  namespace prm {
 
    class PRMObject {
      public:
      // ==========================================================================
      // ==========================================================================

      enum class prm_type : char { ALL, CLASS, PRM_INTERFACE, CLASS_ELT, TYPE, SYSTEM, INSTANCE };
 
      static std::string LEFT_CAST() { return "("; }
 
      static std::string RIGHT_CAST() { return ")"; }

      static std::string enum2str(prm_type type) {
        switch (type) {
          case prm_type::CLASS : return "PRMType::CLASS";
 
          case prm_type::CLASS_ELT : return "PRMType::CLASS_ELT";
 
          case prm_type::TYPE : return "PRMType::TYPE";
 
          case prm_type::SYSTEM : return "PRMType::SYSTEM";
 
          case prm_type::INSTANCE : return "PRMType::INSTANCE";
 
          case prm_type::PRM_INTERFACE : return "PRMType::PRM_INTERFACE";
 
          default : return "unknown";
        }
      }

      static INLINE bool isClass(const PRMObject& obj) { return obj.obj_type() == prm_type::CLASS; }

      static INLINE bool isInterface(const PRMObject& obj) {
        return obj.obj_type() == prm_type::PRM_INTERFACE;
      }

      static INLINE bool isInstance(const PRMObject& obj) {
        return obj.obj_type() == prm_type::INSTANCE;
      }

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

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

      PRMObject(const PRMObject& source);

      PRMObject(PRMObject&& source);

      virtual ~PRMObject();

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

      const std::string& name() const;

      void name(const std::string& name);

      virtual prm_type obj_type() const = 0;

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

      bool operator==(const PRMObject& obj) const;

      bool operator!=(const PRMObject& obj) const;

      PRMObject& operator=(const PRMObject& source);

      PRMObject& operator=(PRMObject&& source);

 
      private:
      // ==========================================================================
      // ==========================================================================
 
      // The name of this object
      // ======================================================================
      std::string _name_;

    };

    std::ostream& operator<<(std::ostream& out, PRMObject::prm_type obj_type);
 
    // list of declarations of PRMObjects
    class PRMType;
    template < typename GUM_SCALAR >
    class PRMClassElement;
    template < typename GUM_SCALAR >
    class PRMClassElementContainer;
    template < typename GUM_SCALAR >
    class PRMAggregate;
    template < typename GUM_SCALAR >
    class PRMInterface;
    template < typename GUM_SCALAR >
    class PRMAttribute;
    template < typename GUM_SCALAR >
    class PRMSlotChain;
    template < typename GUM_SCALAR >
    class PRMReferenceSlot;
    template < typename GUM_SCALAR >
    class PRMClass;
    template < typename GUM_SCALAR >
    class PRMInstance;
    template < typename GUM_SCALAR >
    class PRMSystem;
 
  } /* namespace prm */
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/PRM/elements/PRMObject_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_PRM_OBJECT_H */