PRMClass.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_H
#define GUM_CLASS_H

#include <utility>

#include <agrum/agrum.h>
#include <agrum/core/hashFunc.h>
#include <agrum/core/bijection.h>
#include <agrum/core/sequence.h>
#include <agrum/core/set.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/multidim/implementations/multiDimSparse.h>
#include <agrum/PRM/elements/PRMAggregate.h>
#include <agrum/PRM/elements/PRMAttribute.h>
#include <agrum/PRM/elements/PRMClassElementContainer.h>
#include <agrum/PRM/elements/PRMParameter.h>
#include <agrum/PRM/elements/PRMReferenceSlot.h>
#include <agrum/PRM/elements/PRMSlotChain.h>


namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMInterface;

    template < typename GUM_SCALAR >
    class PRMClass : public PRMClassElementContainer< GUM_SCALAR > {
      friend class PRMInterface< GUM_SCALAR >;

      public:

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

      PRMClass(const std::string&      name,
               PRMClass< GUM_SCALAR >& super,
               bool                    delayInheritance = false);

      PRMClass(const std::string&                        name,
               const Set< PRMInterface< GUM_SCALAR >* >& set,
               bool                                      delayInheritance = false);

      PRMClass(const std::string&                        name,
               PRMClass< GUM_SCALAR >&                   super,
               const Set< PRMInterface< GUM_SCALAR >* >& set,
               bool                                      delayInheritance = false);

      PRMClass(const PRMClass< GUM_SCALAR >& source) = delete;

      PRMClass(const PRMClass< GUM_SCALAR >&& source) = delete;

      PRMClass< GUM_SCALAR >&
         operator=(const PRMClass< GUM_SCALAR >& source) = delete;

      PRMClass< GUM_SCALAR >&
         operator=(const PRMClass< GUM_SCALAR >&& source) = delete;

      virtual ~PRMClass();

      virtual PRMObject::prm_type obj_type() const;
      // ========================================================================
      // ========================================================================

      PRMClassElement< GUM_SCALAR >& get(NodeId id);

      const PRMClassElement< GUM_SCALAR >& get(NodeId id) const;

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

      virtual bool isOutputNode(const PRMClassElement< GUM_SCALAR >& elt) const;

      bool isCastDescendant(const std::string& safe_name) const;

      PRMClassElement< GUM_SCALAR >& get(const std::string& name);

      const PRMClassElement< GUM_SCALAR >& get(const std::string& name) const;

      virtual NodeId add(PRMClassElement< GUM_SCALAR >* elt);

      virtual NodeId overload(PRMClassElement< GUM_SCALAR >* elt);

      virtual void addArc(const std::string& tail, const std::string& head);

      const Set< PRMAttribute< GUM_SCALAR >* >& attributes() const;

      const Set< PRMParameter< GUM_SCALAR >* >& parameters() const;

      HashTable< std::string, const PRMParameter< GUM_SCALAR >* > scope() const;

      const Set< PRMAggregate< GUM_SCALAR >* >& aggregates() const;

      const Set< PRMReferenceSlot< GUM_SCALAR >* >& referenceSlots() const;

      const Set< PRMSlotChain< GUM_SCALAR >* >& slotChains() const;

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

      virtual bool
         isSubTypeOf(const PRMClassElementContainer< GUM_SCALAR >& cec) const;

      const PRMClass< GUM_SCALAR >& super() const;

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

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

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

      PRMClassElement< GUM_SCALAR >& operator[](NodeId id);

      const PRMClassElement< GUM_SCALAR >& operator[](NodeId id) const;

      PRMClassElement< GUM_SCALAR >& operator[](const std::string& name);

      const PRMClassElement< GUM_SCALAR >&
         operator[](const std::string& name) const;


      void inheritReferenceSlots();
      void inheritParameters();
      void inheritAttributes();
      void inheritAggregates();
      void inheritSlotChains();
      void initializeInheritance();
      void completeInheritance(const std::string& attr);

      protected:
      virtual const DAG& _dag() const;

      virtual DAG& _dag();

      void _findAllSubtypes(Set< PRMClassElementContainer< GUM_SCALAR >* >& set);

      void _updateDescendants(const PRMClassElement< GUM_SCALAR >& elt);

      private:
      // void __copyClass<GUM_SCALAR>(const Class<GUM_SCALAR>& c);

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

      DAG __dag;

      NodeProperty< PRMClassElement< GUM_SCALAR >* > __nodeIdMap;

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

      HashTable< std::string, PRMClassElement< GUM_SCALAR >* > __nameMap;

      Set< PRMAttribute< GUM_SCALAR >* > __attributes;

      Set< PRMReferenceSlot< GUM_SCALAR >* > __referenceSlots;

      Set< PRMAggregate< GUM_SCALAR >* > __aggregates;

      Set< PRMSlotChain< GUM_SCALAR >* > __slotChains;

      Set< PRMParameter< GUM_SCALAR >* > __parameters;

      void __addCastDescendants(PRMClassElement< GUM_SCALAR >* attr);

      void __addCastDescendants(PRMAttribute< GUM_SCALAR >* start,
                                PRMAttribute< GUM_SCALAR >* end);

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

      PRMClass< GUM_SCALAR >* __superClass;

      Set< PRMInterface< GUM_SCALAR >* >* __implements;

      Set< PRMClass< GUM_SCALAR >* > __extensions;

      Bijection< const DiscreteVariable*, const DiscreteVariable* >* __bijection;

      HashFunc< PRMClassElementContainer< GUM_SCALAR >* > __dummy_hashfunc;


      void __inheritClass(const PRMClass< GUM_SCALAR >& c);

      void __implementInterfaces(bool delayInheritance);

      void __checkInterfaces(PRMClassElement< GUM_SCALAR >* elt);

      void __checkInterface(PRMClassElement< GUM_SCALAR >* elt,
                            PRMInterface< GUM_SCALAR >*    i);

      void __checkRefInterfaces(PRMReferenceSlot< GUM_SCALAR >* elt);

      void __checkRefInterface(PRMReferenceSlot< GUM_SCALAR >* elt,
                               PRMInterface< GUM_SCALAR >*     i);

      void __addIOInterfaceFlags(PRMClassElement< GUM_SCALAR >* elt);

      void __addExtension(PRMClass< GUM_SCALAR >* c);

      bool
         __checkOverloadLegality(const PRMClassElement< GUM_SCALAR >* overloaded,
                                 const PRMClassElement< GUM_SCALAR >* overloader);

      void __overloadAttribute(PRMAttribute< GUM_SCALAR >* overloader,
                               PRMAttribute< GUM_SCALAR >* overloaded);

      void __overloadAggregate(PRMAggregate< GUM_SCALAR >*    overloader,
                               PRMClassElement< GUM_SCALAR >* overloaded);

      void __overloadReference(PRMReferenceSlot< GUM_SCALAR >* overloader,
                               PRMReferenceSlot< GUM_SCALAR >* overloaded);

      void __overloadParameter(PRMParameter< GUM_SCALAR >* overloader,
                               PRMParameter< GUM_SCALAR >* overloaded);

    };


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


  } /* namespace prm */

}   // namespace gum

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


namespace gum {

  namespace prm {} /* namespace prm */

}   // namespace gum


#endif /* GUM_CLASS_H */