PRMSlotChain.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_SLOT_CHAIN_H
#define GUM_SLOT_CHAIN_H

#include <string>

#include <agrum/core/sequence.h>

#include <agrum/multidim/ICIModels/multiDimNoisyORCompound.h>
#include <agrum/multidim/ICIModels/multiDimNoisyORNet.h>
#include <agrum/multidim/implementations/multiDimBijArray.h>
#include <agrum/multidim/potential.h>

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

namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMClass;
    template < typename GUM_SCALAR >
    class PRMAttribute;

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

      PRMSlotChain(const std::string&                                name,
                   const Sequence< PRMClassElement< GUM_SCALAR >* >& chain);

      PRMSlotChain(Sequence< PRMClassElement< GUM_SCALAR >* >* chain,
                   const std::string&                          name);

      PRMSlotChain(const PRMSlotChain< GUM_SCALAR >& source);

      virtual ~PRMSlotChain();

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

      virtual typename PRMClassElement< GUM_SCALAR >::ClassElementType
         elt_type() const;

      virtual PRMType& type();

      virtual const PRMType& type() const;

      // /// This is similar to the following call: this->lastElt().cpf()
      // virtual Potential<GUM_SCALAR>& cpf();

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

      bool isMultiple() const;

      PRMClassElementContainer< GUM_SCALAR >& end();

      const PRMClassElementContainer< GUM_SCALAR >& end() const;

      PRMClassElement< GUM_SCALAR >& lastElt();

      const PRMClassElement< GUM_SCALAR >& lastElt() const;

      Sequence< PRMClassElement< GUM_SCALAR >* >& chain();

      const Sequence< PRMClassElement< GUM_SCALAR >* >& chain() const;

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

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

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const;
      private:
      PRMSlotChain& operator=(const PRMSlotChain& source);

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

      Sequence< PRMClassElement< GUM_SCALAR >* >* __chain;

      bool __isMultiple;

      void __copyLastElt();

    };


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


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

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

#endif /* GUM_SLOT_CHAIN_H */