aGrUM  0.16.0
PRMSlotChain.h
Go to the documentation of this file.
1 
30 #ifndef GUM_SLOT_CHAIN_H
31 #define GUM_SLOT_CHAIN_H
32 
33 #include <string>
34 
35 #include <agrum/core/sequence.h>
36 
41 
48 
49 namespace gum {
50  namespace prm {
51 
52  template < typename GUM_SCALAR >
53  class PRMClass;
54  template < typename GUM_SCALAR >
55  class PRMAttribute;
56 
81  // ==========================================================================
82  template < typename GUM_SCALAR >
83  class PRMSlotChain : public PRMClassElement< GUM_SCALAR > {
84  public:
85  // ========================================================================
87  // ========================================================================
89 
107  PRMSlotChain(const std::string& name,
108  const Sequence< PRMClassElement< GUM_SCALAR >* >& chain);
109 
127  PRMSlotChain(Sequence< PRMClassElement< GUM_SCALAR >* >* chain,
128  const std::string& name);
129 
135  PRMSlotChain(const PRMSlotChain< GUM_SCALAR >& source);
136 
138  virtual ~PRMSlotChain();
139 
141  // ========================================================================
143  // ========================================================================
145 
148  elt_type() const;
149 
151  virtual PRMType& type();
152 
154  virtual const PRMType& type() const;
155 
156  // /// This is similar to the following call: this->lastElt().cpf()
157  // virtual Potential<GUM_SCALAR>& cpf();
158 
160  virtual const Potential< GUM_SCALAR >& cpf() const;
161 
164  bool isMultiple() const;
165 
168  PRMClassElementContainer< GUM_SCALAR >& end();
169 
172  const PRMClassElementContainer< GUM_SCALAR >& end() const;
173 
176  PRMClassElement< GUM_SCALAR >& lastElt();
177 
180  const PRMClassElement< GUM_SCALAR >& lastElt() const;
181 
184  Sequence< PRMClassElement< GUM_SCALAR >* >& chain();
185 
188  const Sequence< PRMClassElement< GUM_SCALAR >* >& chain() const;
189 
191  virtual void addParent(const PRMClassElement< GUM_SCALAR >& elt);
192 
194  virtual void addChild(const PRMClassElement< GUM_SCALAR >& elt);
195 
198  virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const;
200  private:
202  PRMSlotChain& operator=(const PRMSlotChain& source);
203 
204  // ========================================================================
206  // ========================================================================
208 
211 
214 
217  void __copyLastElt();
218 
220  };
221 
222 
223 #ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
224  extern template class PRMSlotChain< double >;
225 #endif
226 
227 
228  } /* namespace prm */
229 } // namespace gum
230 
232 
233 #endif /* GUM_SLOT_CHAIN_H */
PRMSlotChain & operator=(const PRMSlotChain &source)
Copy operator. Don&#39;t use it.
void __copyLastElt()
Copy the last element, this prevents unwanted DuplicateElement exceptions.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
virtual void addParent(const PRMClassElement< GUM_SCALAR > &elt)
See gum::PRMClassElement<GUM_SCALAR>::_addParent().
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
The generic class for storing (ordered) sequences of objects.
Definition: sequence.h:1022
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
virtual PRMType & type()
This is similar to the following call: this->lastElt().type()
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Definition: agrum.h:25
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
virtual PRMAttribute< GUM_SCALAR > * getCastDescendant() const
Raise a gum::OperationNotAllowed exception See gum::PRMClassElement<GUM_SCALAR>::getCastDescendant() ...
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
virtual const Potential< GUM_SCALAR > & cpf() const
This is similar to the following call: this->lastElt().cpf()
bool isMultiple() const
Return true if this slot chain contains at least one multiple reference slot.
PRMClassElementContainer< GUM_SCALAR > & end()
Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends. ...
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
bool __isMultiple
Flag indicating if this slot chain is multiple or not.
Definition: PRMSlotChain.h:213
PRMSlotChain(const std::string &name, const Sequence< PRMClassElement< GUM_SCALAR > * > &chain)
Default constructor.
virtual ~PRMSlotChain()
Destructor.
virtual PRMClassElement< GUM_SCALAR >::ClassElementType elt_type() const
See gum::PRMClassElement<GUM_SCALAR>::elt_type().
Sequence< PRMClassElement< GUM_SCALAR > *> * __chain
The sequence of PRMClassElement<GUM_SCALAR> composing the slot chain.
Definition: PRMSlotChain.h:210
virtual void addChild(const PRMClassElement< GUM_SCALAR > &elt)
See gum::PRMClassElement<GUM_SCALAR>::_addChild().
PRMClassElement< GUM_SCALAR > & lastElt()
Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggre...
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Sequence< PRMClassElement< GUM_SCALAR > *> & chain()
Return the sequence representing the chain of elements in this PRMSlotChain.
ClassElementType
Returns true if obj_ptr is of type PRMReferenceSlot.