PRMClassElement.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_CLASS_ELEMENT_H
#define GUM_CLASS_ELEMENT_H

#include <sstream>

#include <agrum/agrum.h>

#include <agrum/graphs/graphElements.h>

#include <agrum/multidim/potential.h>

#include <agrum/PRM/elements/PRMObject.h>
#include <agrum/PRM/utils_prm.h>

namespace gum {
  namespace prm {
    template < typename GUM_SCALAR >
    class PRMAttribute;

    template < typename GUM_SCALAR >
    class PRMClassElement : public PRMObject {
      public:
      // ========================================================================
      // ========================================================================

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

      PRMClassElement(const PRMClassElement< GUM_SCALAR >& source);

      virtual ~PRMClassElement();

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

      enum ClassElementType {
        prm_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

      static std::string enum2str(ClassElementType type) {
        switch (type) {
          case prm_attribute: return "prm_attribute";

          case prm_aggregate: return "prm_aggregate";

          case prm_refslot: return "prm_refslot";

          case prm_slotchain: return "prm_slotchain";

          case prm_parameter: return "prm_parameter";

          default: return "unknown";
        }
      }

      static INLINE bool
         isReferenceSlot(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_refslot;
      }

      static INLINE bool isAttribute(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_attribute;
      }

      static INLINE bool isAggregate(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_aggregate;
      }

      static INLINE bool isSlotChain(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_slotchain;
      }

      static INLINE bool isParameter(const PRMClassElement< GUM_SCALAR >& elt) {
        return elt.elt_type() == prm_parameter;
      }

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

      NodeId id() const;

      virtual void setId(NodeId id);

      virtual void addParent(const PRMClassElement< GUM_SCALAR >& elt) = 0;

      virtual void addChild(const PRMClassElement< GUM_SCALAR >& elt) = 0;

      virtual typename PRMObject::prm_type obj_type() const;

      virtual ClassElementType elt_type() const = 0;

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

      virtual PRMType& type() = 0;

      virtual const PRMType& type() const = 0;

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const = 0;

      const std::string& safeName() const;

      virtual std::string cast(const PRMType& t) const;

      // /**
      //  * Return a reference over the gum::Potential of this class element.
      //  * @throw OperationNotAllowed Raised if this class element doesn't have
      //  *                            any gum::Potential (like a
      //  gum::PRMReferenceSlot).
      //  */
      // virtual Potential<GUM_SCALAR>& cpf() = 0;

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

      protected:
      std::string _safeName;

      private:
      NodeId __id;
    };


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

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

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

#endif /* GUM_CLASS_ELEMENT_H */