PRMReferenceSlot.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_REFERENCE_SLOT_H
#define GUM_REFERENCE_SLOT_H

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

namespace gum {
  namespace prm {

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

      PRMReferenceSlot(const std::string&                      name,
                       PRMClassElementContainer< GUM_SCALAR >& type,
                       bool                                    isArray = false);

      virtual ~PRMReferenceSlot();

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

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

      PRMClassElementContainer< GUM_SCALAR >& slotType();

      const PRMClassElementContainer< GUM_SCALAR >& slotType() const;

      bool isArray() const;

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

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

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

      virtual PRMType& type();

      virtual const PRMType& type() const;

      virtual Potential< GUM_SCALAR >& cpf();

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

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const;

      private:
      // ========================================================================
      // ========================================================================
      // @{

      PRMReferenceSlot(const PRMReferenceSlot< GUM_SCALAR >& source);

      PRMReferenceSlot& operator=(const PRMReferenceSlot< GUM_SCALAR >& from);

      // ========================================================================
      // ========================================================================
      // @{

      PRMClassElementContainer< GUM_SCALAR >& __slotType;

      bool __isArray;

    };


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


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

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

#endif /* GUM_CLASS_ELEMENT_H */