gum::prm::PRMReferenceSlot< GUM_SCALAR > Class Template Reference

A PRMReferenceSlot represent a relation between two PRMClassElementContainer. More...

#include <PRMReferenceSlot.h>

Inheritance diagram for gum::prm::PRMReferenceSlot< GUM_SCALAR >:

Collaboration diagram for gum::prm::PRMReferenceSlot< GUM_SCALAR >:

Public Member Functions
Protected constructors & destructor.
	PRMReferenceSlot (const std::string &name, PRMClassElementContainer< GUM_SCALAR > &type, bool isArray=false)
	Default constructor.
virtual	~PRMReferenceSlot ()
	Destructor.
Getters & setters
virtual PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const
	Implementation of the pure virtual method of PRMObject.
PRMClassElementContainer< GUM_SCALAR > &	slotType ()
	Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject).
const PRMClassElementContainer< GUM_SCALAR > &	slotType () const
	Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject).
bool	isArray () const
	Returns true if this reference slot is an array.
virtual void	addParent (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::addParent().
virtual void	addChild (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::addChild().
Not allowed operations on a PRMReferenceSlot.
virtual PRMType &	type ()
	Raise an OperationNotAllowed. See gum::PRMClassElement::type().
virtual const PRMType &	type () const
	Raise an OperationNotAllowed. See gum::PRMClassElement::type().
virtual Tensor< GUM_SCALAR > &	cpf ()
	Raise an OperationNotAllowed. See gum::PRMClassElement::cpf().
virtual const Tensor< GUM_SCALAR > &	cpf () const
	Raise an OperationNotAllowed. See gum::PRMClassElement::cpf().
virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const
	Raise an OperationNotAllowed. See gum::PRMClassElement::getCastDescendant().
Getters & setters
NodeId	id () const
	Returns the NodeId of this element in it's class DAG.
virtual void	setId (NodeId id)
	Used to assign the id of this element.
virtual PRMObject::prm_type	obj_type () const
Fast access to random variable's properties
const std::string &	safeName () const
	Returns the safe name of this PRMClassElement, if any.
virtual std::string	cast (const PRMType &t) const
	Returns the name of the cast descendant with PRMType t of this PRMClassElement.
Getters & setters.
const std::string &	name () const
	Returns the name of this object.
void	name (const std::string &name)
	Change the name of the PRM Object.
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique).
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique).

Protected Attributes
std::string	safeName_
	The safe name of this PRMClassElement.

Private Member Functions
Private methods
	PRMReferenceSlot (const PRMReferenceSlot< GUM_SCALAR > &source)
	Copy constructor. Don't use it.
PRMReferenceSlot &	operator= (const PRMReferenceSlot< GUM_SCALAR > &from)
	Copy operator. Don't use it.

Private Attributes
NodeId	_id_
	The node's id of this element.
Private members
PRMClassElementContainer< GUM_SCALAR > &	_slotType_
	The type of this PRMReferenceSlot.
bool	_isArray_
	Flag indicating if this slot is an array.
Private members.
std::string	_name_

Built-in type
enum	ClassElementType {   prm_attribute , prm_aggregate , prm_refslot , prm_slotchain ,   prm_parameter }
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static std::string	enum2str (ClassElementType type)
	Returns true if obj_ptr is of type PRMReferenceSlot.
static INLINE bool	isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMReferenceSlot.
static INLINE bool	isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMAttribute.
static INLINE bool	isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMAggregate.
static INLINE bool	isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMSlotChain.
static INLINE bool	isParameter (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMParameter.

Built-in types.
enum class	prm_type : char {   ALL , CLASS , PRM_INTERFACE , CLASS_ELT ,   TYPE , SYSTEM , INSTANCE }
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject.
static std::string	LEFT_CAST ()
	Enumeration of the different types of objects handled by a PRM.
static std::string	RIGHT_CAST ()
	Enumeration of the different types of objects handled by a PRM.
static INLINE bool	isClass (const PRMObject &obj)
	Returns true if obj_ptr is of type Class.
static INLINE bool	isInterface (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInterface.
static INLINE bool	isInstance (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInstance.

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::PRMReferenceSlot< GUM_SCALAR >

A PRMReferenceSlot represent a relation between two PRMClassElementContainer.

A reference slot is a relation between two PRMClassElementContainer in a PRM. A PRMReferenceSlot is considered as an element of a PRMClassElementContainer which slot type is a PRMClassElementContainer.

A PRMReferenceSlot is defined by it's slot type (i.e. it's range), it's PRMClassElementContainer (it's domain), it's name and if it is a multiple reference (the isArray() flag).

See also

PRM PRMFactory PRMClassElementContainer PRMClassElement

Definition at line 80 of file PRMReferenceSlot.h.

Member Enumeration Documentation

ClassElementType

template<typename GUM_SCALAR>

enum gum::prm::PRMClassElement::ClassElementType

inherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Enumerator
prm_attribute
prm_aggregate
prm_refslot
prm_slotchain
prm_parameter

Definition at line 109 of file PRMClassElement.h.

                            {
        prm_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

prm_type

enum class gum::prm::PRMObject::prm_type : char

stronginherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 88 of file PRMObject.h.

: char { ALL, CLASS, PRM_INTERFACE, CLASS_ELT, TYPE, SYSTEM, INSTANCE };

Constructor & Destructor Documentation

PRMReferenceSlot() [1/2]

template<typename GUM_SCALAR>

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

Default constructor.

Parameters

name	The name of this element.
type	The type of this reference slot.
isArray	Determine if this reference slot is multiple or not.

Definition at line 55 of file PRMReferenceSlot_tpl.h.

                                                                   :
        PRMClassElement< GUM_SCALAR >(name), _slotType_(type), _isArray_(isArray) {
      GUM_CONSTRUCTOR(PRMReferenceSlot);
      this->safeName_ = PRMObject::LEFT_CAST() + type.name() + PRMObject::RIGHT_CAST() + name;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMReferenceSlot(), _isArray_, _slotType_, isArray(), gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), gum::prm::PRMObject::RIGHT_CAST(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName_, and type().

Referenced by PRMReferenceSlot(), PRMReferenceSlot(), ~PRMReferenceSlot(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

~PRMReferenceSlot()

template<typename GUM_SCALAR>

gum::prm::PRMReferenceSlot< GUM_SCALAR >::~PRMReferenceSlot ( )

virtual

Destructor.

Definition at line 65 of file PRMReferenceSlot_tpl.h.

                                                      {
      GUM_DESTRUCTOR(PRMReferenceSlot);
    }

References PRMReferenceSlot().

Here is the call graph for this function:

PRMReferenceSlot() [2/2]

template<typename GUM_SCALAR>

gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot ( const PRMReferenceSlot< GUM_SCALAR > & source )

private

Copy constructor. Don't use it.

Definition at line 70 of file PRMReferenceSlot_tpl.h.

                                                                                                 :
        PRMClassElement< GUM_SCALAR >(source), _slotType_(source._slotType_),
        _isArray_(source._isArray_) {
      GUM_CONS_CPY(PRMReferenceSlot);
      GUM_ERROR(FatalError, "illegal call to gum::ReferenceSlot copy constructor.")
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMReferenceSlot(), _isArray_, _slotType_, and GUM_ERROR.

Here is the call graph for this function:

Member Function Documentation

addChild()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMReferenceSlot< GUM_SCALAR >::addChild ( const PRMClassElement< GUM_SCALAR > & elt )

virtual

See gum::PRMClassElement::addChild().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 136 of file PRMReferenceSlot_tpl.h.

                                                                                                 {
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement().

Here is the call graph for this function:

addParent()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMReferenceSlot< GUM_SCALAR >::addParent ( const PRMClassElement< GUM_SCALAR > & elt )

virtual

See gum::PRMClassElement::addParent().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 133 of file PRMReferenceSlot_tpl.h.

{}

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement().

Here is the call graph for this function:

cast()

template<typename GUM_SCALAR>

INLINE std::string gum::prm::PRMClassElement< GUM_SCALAR >::cast ( const PRMType & t ) const

virtualinherited

Returns the name of the cast descendant with PRMType t of this PRMClassElement.

Parameters

t	The type in which we want to cast this PRMClassElement.

Exceptions

OperationNotAllowed

If the cast is impossible.

Definition at line 92 of file PRMClassElement_tpl.h.

                                                                               {
      if (type().isSubTypeOf(t)) {
        return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST() + name();
      } else {
        GUM_ERROR(OperationNotAllowed, "illegal cast")
      }
    }

References GUM_ERROR, gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMObject::RIGHT_CAST(), and type().

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant().

Here is the call graph for this function:

Here is the caller graph for this function:

cpf() [1/2]

template<typename GUM_SCALAR>

INLINE Tensor< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::cpf ( )

virtual

Raise an OperationNotAllowed. See gum::PRMClassElement::cpf().

Definition at line 117 of file PRMReferenceSlot_tpl.h.

                                                                     {
      GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.")
    }

cpf() [2/2]

template<typename GUM_SCALAR>

INLINE const Tensor< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::cpf ( ) const

virtual

Raise an OperationNotAllowed. See gum::PRMClassElement::cpf().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 122 of file PRMReferenceSlot_tpl.h.

                                                                                 {
      GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.")
    }

References GUM_ERROR.

elt_type()

template<typename GUM_SCALAR>

INLINE PRMClassElement< GUM_SCALAR >::ClassElementType gum::prm::PRMReferenceSlot< GUM_SCALAR >::elt_type ( ) const

virtual

Implementation of the pure virtual method of PRMObject.

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 86 of file PRMReferenceSlot_tpl.h.

                                                       {
      return this->prm_refslot;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::prm_refslot.

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_().

Here is the caller graph for this function:

enum2str() [1/2]

template<typename GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType type )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 117 of file PRMClassElement.h.

                                                       {
        switch (type) {
          case prm_attribute : return "prm_attribute";
 
          case prm_aggregate : return "prm_aggregate";
 
          case prm_refslot : return "prm_refslot";
 
          case prm_slotchain : return "prm_slotchain";
 
          case prm_parameter : return "prm_parameter";
 
          default : return "unknown";
        }
      }

References prm_aggregate, prm_attribute, prm_parameter, prm_refslot, prm_slotchain, and type().

Here is the call graph for this function:

enum2str() [2/2]

std::string gum::prm::PRMObject::enum2str ( prm_type type )

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 95 of file PRMObject.h.

                                               {
        switch (type) {
          case prm_type::CLASS : return "PRMType::CLASS";
 
          case prm_type::CLASS_ELT : return "PRMType::CLASS_ELT";
 
          case prm_type::TYPE : return "PRMType::TYPE";
 
          case prm_type::SYSTEM : return "PRMType::SYSTEM";
 
          case prm_type::INSTANCE : return "PRMType::INSTANCE";
 
          case prm_type::PRM_INTERFACE : return "PRMType::PRM_INTERFACE";
 
          default : return "unknown";
        }
      }

References CLASS, CLASS_ELT, INSTANCE, PRM_INTERFACE, SYSTEM, and TYPE.

Referenced by gum::prm::operator<<().

Here is the caller graph for this function:

getCastDescendant()

template<typename GUM_SCALAR>

INLINE PRMAttribute< GUM_SCALAR > * gum::prm::PRMReferenceSlot< GUM_SCALAR >::getCastDescendant ( ) const

virtual

Raise an OperationNotAllowed. See gum::PRMClassElement::getCastDescendant().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 127 of file PRMReferenceSlot_tpl.h.

                                                                                               {
      GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.")
    }

References GUM_ERROR.

id()

template<typename GUM_SCALAR>

INLINE NodeId gum::prm::PRMClassElement< GUM_SCALAR >::id ( ) const

inherited

Returns the NodeId of this element in it's class DAG.

Definition at line 72 of file PRMClassElement_tpl.h.

                                                          {
      return _id_;
    }

References _id_.

Referenced by PRMClassElement(), gum::prm::PRMSlotChain< double >::PRMSlotChain(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::SVE< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< double >::_groundTensor_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::InstanceBayesNet< GUM_SCALAR >::_init_(), gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::addArc(), gum::prm::PRMInterface< double >::addArc(), gum::prm::PRMInterface< double >::implementations(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::SVE< GUM_SCALAR >::posterior_(), gum::prm::SVED< GUM_SCALAR >::posterior_(), setId(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

Here is the caller graph for this function:

isAggregate()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > & elt )

inlinestaticinherited

Return true if obj is of type PRMAggregate.

Definition at line 144 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_aggregate;
      }

References PRMClassElement(), elt_type(), and prm_aggregate.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAggregator(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

isArray()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMReferenceSlot< GUM_SCALAR >::isArray

(

)

const

Returns true if this reference slot is an array.

Definition at line 102 of file PRMReferenceSlot_tpl.h.

                                                              {
      return _isArray_;
    }

References _isArray_.

Referenced by PRMReferenceSlot(), and gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain().

Here is the caller graph for this function:

isAttribute()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > & elt )

inlinestaticinherited

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 139 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_attribute;
      }

References PRMClassElement(), elt_type(), and prm_attribute.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMSystem< double >::_groundAttr_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

isClass()

INLINE bool gum::prm::PRMObject::isClass ( const PRMObject & obj )

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 114 of file PRMObject.h.

{ return obj.obj_type() == prm_type::CLASS; }

References PRMObject(), CLASS, and obj_type().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::scope(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

isInstance()

INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject & obj )

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 122 of file PRMObject.h.

                                                          {
        return obj.obj_type() == prm_type::INSTANCE;
      }

References PRMObject(), INSTANCE, and obj_type().

Here is the call graph for this function:

isInterface()

INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject & obj )

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 117 of file PRMObject.h.

                                                           {
        return obj.obj_type() == prm_type::PRM_INTERFACE;
      }

References PRMObject(), obj_type(), and PRM_INTERFACE.

Here is the call graph for this function:

isParameter()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > & elt )

inlinestaticinherited

Return true if obj is of type PRMParameter.

Definition at line 154 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_parameter;
      }

References PRMClassElement(), elt_type(), and prm_parameter.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkParameters_(), and gum::prm::PRMClass< GUM_SCALAR >::add().

Here is the call graph for this function:

Here is the caller graph for this function:

isReferenceSlot()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > & elt )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 134 of file PRMClassElement.h.

                                                                                   {
        return elt.elt_type() == prm_refslot;
      }

References PRMClassElement(), elt_type(), and prm_refslot.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkAssignments_(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkIncrements_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkReferenceSlot_(), and gum::prm::PRMFactory< GUM_SCALAR >::setReferenceSlot().

Here is the call graph for this function:

Here is the caller graph for this function:

isSlotChain()

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > & elt )

inlinestaticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 149 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_slotchain;
      }

References PRMClassElement(), elt_type(), and prm_slotchain.

Referenced by gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::PRMFactory< GUM_SCALAR >::_retrieveInputs_(), gum::prm::PRMClass< GUM_SCALAR >::add(), and gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound().

Here is the call graph for this function:

Here is the caller graph for this function:

LEFT_CAST()

std::string gum::prm::PRMObject::LEFT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 90 of file PRMObject.h.

{ return "("; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

Here is the caller graph for this function:

name() [1/2]

INLINE const std::string & gum::prm::PRMObject::name ( ) const

inherited

Returns the name of this object.

Definition at line 54 of file PRMObject_inl.h.

{ return _name_; }

References _name_.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute(), gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), PRMObject(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< double >::PRMSlotChain(), gum::prm::PRMSystem< GUM_SCALAR >::PRMSystem(), gum::prm::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::SVE< GUM_SCALAR >::_addDelayedVariable_(), gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_addReferingInstance_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMFactory< GUM_SCALAR >::_checkInterfaceImplementation_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRawCPT_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRuleCPTSumsTo1_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundAgg_(), gum::prm::PRMSystem< double >::_groundAgg_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< double >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMSystem< GUM_SCALAR >::exists(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::getArray(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMSystem< double >::instantiate(), gum::prm::PRMSystem< GUM_SCALAR >::isArray(), gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::isInstance(), name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), operator!=(), gum::prm::PRMClass< GUM_SCALAR >::operator=(), operator==(), gum::prm::PRMType::operator==(), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainterConstIterator, gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::startSystem().

name() [2/2]

INLINE void gum::prm::PRMObject::name ( const std::string & name )

inherited

Change the name of the PRM Object.

Warning

Don't do this unless you know what you are doing !

Definition at line 58 of file PRMObject_inl.h.

{ _name_ = name; }

References _name_, and name().

Here is the call graph for this function:

obj_type()

template<typename GUM_SCALAR>

INLINE PRMObject::prm_type gum::prm::PRMClassElement< GUM_SCALAR >::obj_type ( ) const

virtualinherited

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 77 of file PRMClassElement_tpl.h.

                                                                           {
      return prm_type::CLASS_ELT;
    }

References gum::prm::PRMObject::CLASS_ELT.

operator!=()

INLINE bool gum::prm::PRMObject::operator!= ( const PRMObject & obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 66 of file PRMObject_inl.h.

{ return _name_ != obj.name(); }

References PRMObject(), _name_, and name().

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR>

PRMReferenceSlot< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::operator= ( const PRMReferenceSlot< GUM_SCALAR > & from )

private

Copy operator. Don't use it.

Definition at line 80 of file PRMReferenceSlot_tpl.h.

                                                                                          {
      GUM_ERROR(FatalError, "illegal call to gum::ReferenceSlot copy operator.")
    }

References PRMReferenceSlot(), and GUM_ERROR.

Here is the call graph for this function:

operator==()

INLINE bool gum::prm::PRMObject::operator== ( const PRMObject & obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 62 of file PRMObject_inl.h.

{ return _name_ == obj.name(); }

References PRMObject(), _name_, and name().

Here is the call graph for this function:

RIGHT_CAST()

std::string gum::prm::PRMObject::RIGHT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 92 of file PRMObject.h.

{ return ")"; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

Here is the caller graph for this function:

safeName()

template<typename GUM_SCALAR>

INLINE const std::string & gum::prm::PRMClassElement< GUM_SCALAR >::safeName ( ) const

inherited

Returns the safe name of this PRMClassElement, if any.

This will only work if this PRMClassElement is an PRMAttribute or an PRMAggregate.

Returns

Returns the safe name of this PRMClassElement.

Exceptions

NotFound&

Raised if this PRMClassElement does not have any safe name.

Definition at line 87 of file PRMClassElement_tpl.h.

                                                                          {
      return safeName_;
    }

References safeName_.

Referenced by gum::prm::__print_attribute__(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttributeCPF_(), gum::prm::SVED< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< double >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAggregate_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMInterface< double >::addArc(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::belongsTo(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMInterface< double >::implementations(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setIOFlag_(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the caller graph for this function:

setId()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMClassElement< GUM_SCALAR >::setId ( NodeId id )

virtualinherited

Used to assign the id of this element.

Definition at line 82 of file PRMClassElement_tpl.h.

                                                              {
      _id_ = id;
    }

References _id_, and id().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< double >::addArc(), gum::prm::PRMInterface< double >::implementations(), and gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates().

Here is the call graph for this function:

Here is the caller graph for this function:

slotType() [1/2]

template<typename GUM_SCALAR>

INLINE PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType

(

)

Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject).

Definition at line 91 of file PRMReferenceSlot_tpl.h.

                                                                                            {
      return _slotType_;
    }

References _slotType_.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::_buildSlotChain_(), gum::prm::PRMFactory< GUM_SCALAR >::_checkInterfaceImplementation_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::PRMSlotChain< double >::addChild(), gum::prm::PRMSlotChain< GUM_SCALAR >::end(), and gum::prm::PRMInterface< double >::operator[]().

Here is the caller graph for this function:

slotType() [2/2]

template<typename GUM_SCALAR>

INLINE const PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType

(

)

const

Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject).

Definition at line 97 of file PRMReferenceSlot_tpl.h.

                                                                {
      return _slotType_;
    }

References _slotType_.

type() [1/2]

template<typename GUM_SCALAR>

INLINE PRMType & gum::prm::PRMReferenceSlot< GUM_SCALAR >::type ( )

virtual

Raise an OperationNotAllowed. See gum::PRMClassElement::type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 107 of file PRMReferenceSlot_tpl.h.

                                                         {
      GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.")
    }

References GUM_ERROR.

Referenced by PRMReferenceSlot().

Here is the caller graph for this function:

type() [2/2]

template<typename GUM_SCALAR>

INLINE const PRMType & gum::prm::PRMReferenceSlot< GUM_SCALAR >::type ( ) const

virtual

Raise an OperationNotAllowed. See gum::PRMClassElement::type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 112 of file PRMReferenceSlot_tpl.h.

                                                                     {
      GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.")
    }

Member Data Documentation

_id_

template<typename GUM_SCALAR>

NodeId gum::prm::PRMClassElement< GUM_SCALAR >::_id_

privateinherited

The node's id of this element.

Definition at line 278 of file PRMClassElement.h.

Referenced by PRMClassElement(), id(), and setId().

_isArray_

template<typename GUM_SCALAR>

bool gum::prm::PRMReferenceSlot< GUM_SCALAR >::_isArray_

private

Flag indicating if this slot is an array.

Definition at line 187 of file PRMReferenceSlot.h.

Referenced by PRMReferenceSlot(), PRMReferenceSlot(), and isArray().

_name_

std::string gum::prm::PRMObject::_name_

privateinherited

Definition at line 211 of file PRMObject.h.

Referenced by PRMObject(), PRMObject(), PRMObject(), name(), name(), operator!=(), operator=(), operator=(), and operator==().

_slotType_

template<typename GUM_SCALAR>

PRMClassElementContainer< GUM_SCALAR >& gum::prm::PRMReferenceSlot< GUM_SCALAR >::_slotType_

private

The type of this PRMReferenceSlot.

Definition at line 184 of file PRMReferenceSlot.h.

Referenced by PRMReferenceSlot(), PRMReferenceSlot(), slotType(), and slotType().

safeName_

template<typename GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::safeName_

protectedinherited

The safe name of this PRMClassElement.

Definition at line 274 of file PRMClassElement.h.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), and safeName().

---

The documentation for this class was generated from the following files:

• agrum/PRM/elements/PRMObject.h
• agrum/PRM/elements/PRMReferenceSlot.h
• agrum/PRM/elements/PRMReferenceSlot_tpl.h