PRMParameter.h

Go to the documentation of this file.

#ifndef GUM_PARAMETER_H
#define GUM_PARAMETER_H

#include <agrum/multidim/potential.h>

#include <agrum/PRM/elements/PRMType.h>
#include <agrum/PRM/elements/PRMClassElement.h>
#include <agrum/PRM/elements/PRMAttribute.h>


namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMParameter : public PRMClassElement< GUM_SCALAR > {
      public:
      enum ParameterType { INT, REAL };

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

      PRMParameter(const std::string& name, ParameterType type, GUM_SCALAR value);

      virtual ~PRMParameter();

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

      virtual typename PRMClassElement< GUM_SCALAR >::ClassElementType
         elt_type() const;

      GUM_SCALAR value() const;

      void value(GUM_SCALAR value);

      ParameterType valueType() const;

      virtual PRMType& type();

      virtual const PRMType& type() const;

      virtual Potential< GUM_SCALAR >& cpf();

      virtual const Potential< GUM_SCALAR >& cpf() const;

      void addParent(const gum::prm::PRMClassElement< GUM_SCALAR >&);

      void addChild(const gum::prm::PRMClassElement< GUM_SCALAR >&);

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const;

      protected:
      PRMParameter(const PRMParameter< GUM_SCALAR >& source);

      PRMParameter< GUM_SCALAR >&
         operator=(const PRMParameter< GUM_SCALAR >& from);

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

      ParameterType __type;

      GUM_SCALAR __value;

    };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMParameter< double >;
#endif


  } /* namespace prm */
}   // namespace gum

#include <agrum/PRM/elements/PRMParameter_tpl.h>

#endif /* GUM_PARAMETER_H */