PRMObject.h

Go to the documentation of this file.

#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 */