PRMInstance.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_INSTANCE_H
#define GUM_INSTANCE_H

#include <set>
#include <utility>

#include <agrum/core/bijection.h>

#include <agrum/PRM/elements/PRMClass.h>
#include <agrum/PRM/elements/PRMClassElementContainer.h>

namespace gum {
  namespace prm {


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

      PRMInstance< GUM_SCALAR >(const std::string&      name,
                                PRMClass< GUM_SCALAR >& type);

      virtual ~PRMInstance< GUM_SCALAR >();

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

      virtual prm_type obj_type() const;

      PRMClass< GUM_SCALAR >& type();

      const PRMClass< GUM_SCALAR >& type() const;

      bool exists(NodeId id) const;

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

      PRMAttribute< GUM_SCALAR >& get(NodeId id);

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

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

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

      Size size() const;

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

      void instantiate();

      const Bijection< const DiscreteVariable*, const DiscreteVariable* >&
         bijection() const;

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

      void add(NodeId id, PRMInstance< GUM_SCALAR >& instance);

      const PRMInstance< GUM_SCALAR >& getInstance(NodeId id) const;

      const Set< PRMInstance< GUM_SCALAR >* >& getInstances(NodeId id) const;

      bool hasRefAttr(NodeId id) const;

      std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >&
         getRefAttr(NodeId id);

      const std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >&
         getRefAttr(NodeId id) const;

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

      typedef
         typename NodeProperty< PRMAttribute< GUM_SCALAR >* >::iterator iterator;

      iterator begin();

      const iterator& end();

      typedef typename NodeProperty< PRMAttribute< GUM_SCALAR >* >::const_iterator
         const_iterator;

      const_iterator begin() const;

      const const_iterator& end() const;

      class RefIterator {
        public:
        explicit RefIterator(Set< PRMInstance< GUM_SCALAR >* >& set);

        RefIterator(const RefIterator& from);

        ~RefIterator();

        RefIterator& operator=(const RefIterator& from);

        RefIterator& operator++();

        bool isEnd() const;

        bool operator!=(const RefIterator& from) const;

        bool operator==(const RefIterator& from) const;

        PRMInstance< GUM_SCALAR >& operator*() const;
        PRMInstance< GUM_SCALAR >* operator->() const;

        private:
        Set< PRMInstance< GUM_SCALAR >* >&                   __set;
        typename Set< PRMInstance< GUM_SCALAR >* >::iterator __iter;
      };

      RefIterator begin(NodeId id);

      class RefConstIterator {
        public:
        explicit RefConstIterator(const Set< PRMInstance< GUM_SCALAR >* >& set);

        RefConstIterator(const RefConstIterator& from);

        ~RefConstIterator();

        RefConstIterator& operator=(const RefConstIterator& from);

        RefConstIterator& operator++();

        bool isEnd() const;

        bool operator!=(const RefConstIterator& from) const;

        bool operator==(const RefConstIterator& from) const;

        const PRMInstance< GUM_SCALAR >& operator*() const;
        const PRMInstance< GUM_SCALAR >* operator->() const;

        private:
        const Set< PRMInstance< GUM_SCALAR >* >&                   __set;
        typename Set< PRMInstance< GUM_SCALAR >* >::const_iterator __iter;
      };

      RefConstIterator begin(NodeId id) const;

      typedef typename NodeProperty< std::vector<
         std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::iterator
         InvRefIterator;
      typedef typename NodeProperty< std::vector<
         std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::const_iterator
         InvRefConstIterator;

      InvRefIterator        beginInvRef();
      const InvRefIterator& endInvRef();

      InvRefConstIterator        beginInvRef() const;
      const InvRefConstIterator& endInvRef() const;

      private:
      PRMInstance(const PRMInstance< GUM_SCALAR >& source);

      PRMInstance< GUM_SCALAR >& operator=(const PRMClass< GUM_SCALAR >& from);

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

      void __copyAggregates(PRMAggregate< GUM_SCALAR >* source);

      void __copyAttribute(PRMAttribute< GUM_SCALAR >* source);

      void __doInstantiate();

      void __instantiateSlotChain(PRMSlotChain< GUM_SCALAR >* sc);

      void __copyAttributeCPF(PRMAttribute< GUM_SCALAR >* attr);

      void __addReferingInstance(PRMSlotChain< GUM_SCALAR >* sc,
                                 PRMInstance< GUM_SCALAR >*  i);

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

      bool __instantiated;

      PRMClass< GUM_SCALAR >* __type;

      NodeProperty< PRMAttribute< GUM_SCALAR >* > __nodeIdMap;

      NodeProperty< Set< PRMInstance< GUM_SCALAR >* >* > __referenceMap;

      typedef std::pair< PRMInstance< GUM_SCALAR >*, std::string > pair;

      NodeProperty< std::vector< pair >* > __referingAttr;

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

    };


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


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

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

#endif /* GUM_INSTANCE_H */