PRMInterface.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_INTERFACE_H
#define GUM_INTERFACE_H

#include <set>
#include <utility>
#include <string>

#include <agrum/agrum.h>
#include <agrum/core/sequence.h>
#include <agrum/core/set.h>

#include <agrum/PRM/elements/PRMClassElement.h>
#include <agrum/PRM/elements/PRMClassElementContainer.h>
#include <agrum/PRM/elements/PRMAttribute.h>
#include <agrum/PRM/elements/PRMReferenceSlot.h>
#include <agrum/PRM/elements/PRMScalarAttribute.h>


namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMClass;

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

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

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

      PRMInterface(const PRMInterface< GUM_SCALAR >& source);

      virtual ~PRMInterface();

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

      virtual typename PRMObject::prm_type obj_type() const;

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

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

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

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

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

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

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

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

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

      NodeId add(PRMClassElement< GUM_SCALAR >* elt);

      NodeId overload(PRMClassElement< GUM_SCALAR >* elt);

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

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

      PRMInterface< GUM_SCALAR >& super();

      const PRMInterface< GUM_SCALAR >& super() const;

      Set< PRMClass< GUM_SCALAR >* >& implementations();

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

      void inheritInterface();

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

      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;

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

      typedef typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::iterator
                              ClassEltIterator;
      ClassEltIterator        begin();
      const ClassEltIterator& end();

      typedef
         typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::const_iterator
                                    const_ClassEltIterator;
      const_ClassEltIterator        begin() const;
      const const_ClassEltIterator& end() const;

      protected:
      const DAG& _dag() const;

      DAG& _dag();

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

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

      private:
      PRMInterface< GUM_SCALAR >&
         operator=(const PRMInterface< GUM_SCALAR >& source);

      void __inheritInterface(const PRMInterface< GUM_SCALAR >& i);

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

      DAG __dag;

      NodeProperty< PRMClassElement< GUM_SCALAR >* > __nodeIdMap;

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

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

      Set< PRMAttribute< GUM_SCALAR >* > __attributes;

      Set< PRMReferenceSlot< GUM_SCALAR >* > __referenceSlots;

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

      PRMInterface< GUM_SCALAR >* __superInterface;

      Set< PRMClass< GUM_SCALAR >* > __implementations;

      void __addImplementation(PRMClass< GUM_SCALAR >* c);

      Set< PRMInterface< GUM_SCALAR >* > __extensions;

      void __addExtension(PRMInterface< 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 __overloadReferenceSlot(PRMReferenceSlot< GUM_SCALAR >* overloader,
                                   PRMReferenceSlot< GUM_SCALAR >* overloaded);

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

    };


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


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

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

#endif /* GUM_INTERFACE_H */