PRMClassElementContainer.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_CONTAINER_H
#define GUM_CLASS_ELEMENT_CONTAINER_H

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

#include <agrum/graphs/DAG.h>
#include <agrum/graphs/graphElements.h>

#include <agrum/PRM/utils_prm.h>

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

namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMClass;
    template < typename GUM_SCALAR >
    class PRMInterface;
    class PRMClassElementContainterIterator;
    class PRMClassElementContainterConstIterator;

    template < typename GUM_SCALAR >
    class PRMClassElementContainer : public PRMObject {
      friend class PRMClassElementContainterIterator;
      friend class PRMClassElementContainterConstIterator;

      public:
      // ========================================================================
      // ========================================================================

      PRMClassElementContainer(const std::string& name);

      virtual ~PRMClassElementContainer();

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

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

      virtual bool exists(const std::string& name) const;

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

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

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

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

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

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

      virtual void setInputNode(const PRMClassElement< GUM_SCALAR >& elt, bool b);

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

      virtual void setOutputNode(const PRMClassElement< GUM_SCALAR >& elt, bool b);

      virtual bool isInnerNode(const PRMClassElement< GUM_SCALAR >& elt) const;
      // ========================================================================
      // ========================================================================

      virtual const DAG& containerDag() const;

      virtual bool exists(NodeId id) const;

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

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

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

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

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

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

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

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

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

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


      protected:
      PRMClassElementContainer< GUM_SCALAR >&
         operator=(const PRMClassElementContainer< GUM_SCALAR >& source);

      PRMClassElementContainer(
         const PRMClassElementContainer< GUM_SCALAR >& source);

      virtual const DAG& _dag() const = 0;

      virtual DAG& _dag() = 0;

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

      virtual std::pair< bool, bool >&
         _getIOFlag(const PRMClassElement< GUM_SCALAR >& elt);

      virtual const std::pair< bool, bool >&
         _getIOFlag(const PRMClassElement< GUM_SCALAR >& elt) const;

      virtual void _setIOFlag(const PRMClassElement< GUM_SCALAR >& elt,
                              const std::pair< bool, bool >&       flags);

      virtual void _copyIOFlags(const PRMClassElementContainer< GUM_SCALAR >& c);

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

      private:
      HashTable< std::string, std::pair< bool, bool > > __IOFlags;
    };


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


  } /* namespace prm */

}   // namespace gum

template < typename GUM_SCALAR >
std::ostream&
   operator<<(std::ostream&                                           output,
              const gum::prm::PRMClassElementContainer< GUM_SCALAR >& container);

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

#endif /* GUM_CLASS_ELEMENT_CONTAINER_H */