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

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

#include <PRMObject.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. More...
 
virtual ~PRMReferenceSlot ()
 Destructor. More...
 
Getters & setters
virtual PRMClassElement< GUM_SCALAR >::ClassElementType elt_type () const
 Implementation of the pure virtual method of PRMObject. More...
 
PRMClassElementContainer< GUM_SCALAR > & slotType ()
 Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject). More...
 
const PRMClassElementContainer< GUM_SCALAR > & slotType () const
 Returns the type of this slot, which is a PRMClassElementContainer (it is not the type of PRMObject). More...
 
bool isArray () const
 Returns true if this reference slot is an array. More...
 
virtual void addParent (const PRMClassElement< GUM_SCALAR > &elt)
 See gum::PRMClassElement::addParent(). More...
 
virtual void addChild (const PRMClassElement< GUM_SCALAR > &elt)
 See gum::PRMClassElement::addChild(). More...
 
Not allowed operations on a PRMReferenceSlot.
virtual PRMType< GUM_SCALAR > & type ()
 Raise an OperationNotAllowed. See gum::PRMClassElement::type(). More...
 
virtual const PRMType< GUM_SCALAR > & type () const
 Raise an OperationNotAllowed. See gum::PRMClassElement::type(). More...
 
virtual Potential< GUM_SCALAR > & cpf ()
 Raise an OperationNotAllowed. See gum::PRMClassElement::cpf(). More...
 
virtual const Potential< GUM_SCALAR > & cpf () const
 Raise an OperationNotAllowed. See gum::PRMClassElement::cpf(). More...
 
virtual PRMAttribute< GUM_SCALAR > * getCastDescendant () const
 Raise an OperationNotAllowed. See gum::PRMClassElement::getCastDescendant(). More...
 
Getters & setters
NodeId id () const
 Returns the NodeId of this element in it's class DAG. More...
 
virtual void setId (NodeId id)
 Used to assign the id of this element. More...
 
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. More...
 
virtual std::string cast (const PRMType< GUM_SCALAR > &t) const
 Returns the name of the cast descendant with PRMType t of this PRMClassElement. More...
 
Getters & setters.
const std::string & name () const
 Returns the name of this object. More...
 
void name (const std::string &name)
 Change the name of the PRM Object. More...
 
Operators
bool operator== (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique). More...
 
bool operator!= (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique). More...
 

Protected Attributes

std::string _safeName
 The safe name of this PRMClassElement. More...
 

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. More...
 
static INLINE bool isReferenceSlot (const PRMClassElement &elt)
 Returns true if obj_ptr is of type PRMReferenceSlot. More...
 
static INLINE bool isAttribute (const PRMClassElement &elt)
 Returns true if obj_ptr is of type PRMAttribute. More...
 
static INLINE bool isAggregate (const PRMClassElement &elt)
 Return true if obj is of type PRMAggregate. More...
 
static INLINE bool isSlotChain (const PRMClassElement &elt)
 Return true if obj is of type PRMSlotChain. More...
 
static INLINE bool isParameter (const PRMClassElement &elt)
 Return true if obj is of type PRMParameter. More...
 

Built-in types.

enum  prm_type : char {
  prm_type::ALL, prm_type::CLASS, prm_type::PRM_INTERFACE, prm_type::CLASS_ELT,
  prm_type::TYPE, prm_type::SYSTEM, prm_type::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. More...
 
static std::string LEFT_CAST ()
 Enumeration of the different types of objects handled by a PRM. More...
 
static std::string RIGHT_CAST ()
 Enumeration of the different types of objects handled by a PRM. More...
 
static INLINE bool isClass (const PRMObject &obj)
 Returns true if obj_ptr is of type Class. More...
 
static INLINE bool isInterface (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInterface. More...
 
static INLINE bool isInstance (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInstance. More...
 

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 221 of file PRMObject.h.

Member Enumeration Documentation

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 90 of file PRMClassElement.h.

enum 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 66 of file PRMObject.h.

66  : char {
67  ALL,
68  CLASS,
69  PRM_INTERFACE,
70  CLASS_ELT,
71  TYPE,
72  SYSTEM,
73  INSTANCE
74  };

Constructor & Destructor Documentation

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

Default constructor.

Parameters
nameThe name of this element.
typeThe type of this reference slot.
isArrayDetermine if this reference slot is multiple or not.

Definition at line 32 of file PRMReferenceSlot_tpl.h.

References gum::prm::PRMClassElement< GUM_SCALAR >::_safeName, gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), and gum::prm::PRMObject::RIGHT_CAST().

35  :
36  PRMClassElement< GUM_SCALAR >(name),
37  __slotType(type), __isArray(isArray) {
38  GUM_CONSTRUCTOR(PRMReferenceSlot);
39  this->_safeName =
41  }
PRMClassElementContainer< GUM_SCALAR > & __slotType
The type of this PRMReferenceSlot.
virtual PRMType< GUM_SCALAR > & type()
Raise an OperationNotAllowed. See gum::PRMClassElement::type().
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
PRMReferenceSlot(const std::string &name, PRMClassElementContainer< GUM_SCALAR > &type, bool isArray=false)
Default constructor.
bool __isArray
Flag indicating if this slot is an array.
static std::string LEFT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:76
static std::string RIGHT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:77
std::string _safeName
The safe name of this PRMClassElement.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
gum::prm::PRMReferenceSlot< GUM_SCALAR >::~PRMReferenceSlot ( )
virtual

Destructor.

Definition at line 45 of file PRMReferenceSlot_tpl.h.

45  {
46  GUM_DESTRUCTOR(PRMReferenceSlot);
47  }
PRMReferenceSlot(const std::string &name, PRMClassElementContainer< GUM_SCALAR > &type, bool isArray=false)
Default constructor.
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 50 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR, and gum::prm::PRMReferenceSlot< GUM_SCALAR >::operator=().

51  :
52  PRMClassElement< GUM_SCALAR >(source),
53  __slotType(source.__slotType), __isArray(source.__isArray) {
54  GUM_CONS_CPY(PRMReferenceSlot);
55  GUM_ERROR(FatalError,
56  "illegal call to gum::ReferenceSlot copy constructor.");
57  }
PRMClassElementContainer< GUM_SCALAR > & __slotType
The type of this PRMReferenceSlot.
PRMReferenceSlot(const std::string &name, PRMClassElementContainer< GUM_SCALAR > &type, bool isArray=false)
Default constructor.
bool __isArray
Flag indicating if this slot is an array.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

Member Function Documentation

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 123 of file PRMReferenceSlot_tpl.h.

124  {}
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 119 of file PRMReferenceSlot_tpl.h.

120  {}
template<typename GUM_SCALAR>
INLINE std::string gum::prm::PRMClassElement< GUM_SCALAR >::cast ( const PRMType< GUM_SCALAR > &  t) const
virtualinherited

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

Parameters
tThe type in which we want to cast this PRMClassElement.
Exceptions
OperationNotAllowedIf the cast is impossible.

Definition at line 71 of file PRMClassElement_tpl.h.

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

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant(), and gum::prm::PRMClassElement< double >::isParameter().

71  {
72  if (type().isSubTypeOf(t)) {
73  return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST()
74  + name();
75  } else {
76  GUM_ERROR(OperationNotAllowed, "illegal cast");
77  }
78  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
static std::string LEFT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:76
static std::string RIGHT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:77
virtual PRMType< GUM_SCALAR > & type()=0
Return a reference over the gum::PRMType of this class element.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
INLINE Potential< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::cpf ( )
virtual

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

Definition at line 101 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

101  {
102  GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.");
103  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
template<typename GUM_SCALAR >
INLINE const Potential< 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 107 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

107  {
108  GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.");
109  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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 68 of file PRMReferenceSlot_tpl.h.

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

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

68  {
69  return this->prm_refslot;
70  }

+ Here is the caller graph for this function:

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

Returns the string representation of a PRMObject.

Definition at line 80 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, gum::prm::PRMObject::CLASS_ELT, gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::PRM_INTERFACE, gum::prm::PRMObject::SYSTEM, and gum::prm::PRMObject::TYPE.

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

80  {
81  switch (type) {
82  case prm_type::CLASS: return "PRMType::CLASS";
83 
84  case prm_type::CLASS_ELT: return "PRMType::CLASS_ELT";
85 
86  case prm_type::TYPE: return "PRMType::TYPE";
87 
88  case prm_type::SYSTEM: return "PRMType::SYSTEM";
89 
90  case prm_type::INSTANCE: return "PRMType::INSTANCE";
91 
92  case prm_type::PRM_INTERFACE: return "PRMType::PRM_INTERFACE";
93 
94  default: return "unknown";
95  }
96  }

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
static std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType  type)
inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 98 of file PRMClassElement.h.

98  {
99  switch (type) {
100  case prm_attribute: return "prm_attribute";
101 
102  case prm_aggregate: return "prm_aggregate";
103 
104  case prm_refslot: return "prm_refslot";
105 
106  case prm_slotchain: return "prm_slotchain";
107 
108  case prm_parameter: return "prm_parameter";
109 
110  default: return "unknown";
111  }
112  }
virtual PRMType< GUM_SCALAR > & type()=0
Return a reference over the gum::PRMType of this class element.
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 113 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

113  {
114  GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.");
115  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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 50 of file PRMClassElement_tpl.h.

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

Referenced by gum::prm::PRMClass< GUM_SCALAR >::__addCastDescendants(), gum::prm::PRMInterface< 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::PRMSlotChain< GUM_SCALAR >::__copyLastElt(), gum::prm::SVE< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< GUM_SCALAR >::__groundPotential(), gum::prm::PRMClass< GUM_SCALAR >::__inheritClass(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), gum::prm::PRMInterface< GUM_SCALAR >::__overloadAttribute(), 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::SVED< GUM_SCALAR >::_marginal(), gum::prm::SVE< GUM_SCALAR >::_marginal(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::addArc(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMClassElement< GUM_SCALAR >::setId(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

50  {
51  return __id;
52  }
NodeId __id
The node&#39;s id of this element.

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
static 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 125 of file PRMClassElement.h.

Referenced by gum::prm::PRMClass< GUM_SCALAR >::__checkInterface(), gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

125  {
126  return elt.elt_type() == prm_aggregate;
127  }

+ Here is the caller graph for this function:

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 85 of file PRMReferenceSlot_tpl.h.

References gum::prm::PRMReferenceSlot< GUM_SCALAR >::__isArray.

85  {
86  return __isArray;
87  }
bool __isArray
Flag indicating if this slot is an array.
template<typename GUM_SCALAR>
static 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 120 of file PRMClassElement.h.

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

120  {
121  return elt.elt_type() == prm_attribute;
122  }

+ Here is the caller graph for this function:

static INLINE bool gum::prm::PRMObject::isClass ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 99 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, and gum::prm::PRMObject::obj_type().

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::name(), gum::prm::PRMObject::obj_type(), gum::prm::PRMObject::operator!=(), gum::prm::PRMObject::operator=(), gum::prm::PRMObject::operator==(), gum::prm::PRMObject::PRMObject(), and gum::prm::PRMObject::~PRMObject().

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

+ Here is the call graph for this function:

static INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 104 of file PRMObject.h.

References gum::prm::PRMObject::obj_type(), and gum::prm::PRMObject::PRM_INTERFACE.

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

+ Here is the call graph for this function:

template<typename GUM_SCALAR>
static 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 135 of file PRMClassElement.h.

135  {
136  return elt.elt_type() == prm_parameter;
137  }
template<typename GUM_SCALAR>
static 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 115 of file PRMClassElement.h.

115  {
116  return elt.elt_type() == prm_refslot;
117  }
template<typename GUM_SCALAR>
static 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 130 of file PRMClassElement.h.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::__retrieveInputs().

130  {
131  return elt.elt_type() == prm_slotchain;
132  }

+ Here is the caller graph for this function:

static 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 76 of file PRMObject.h.

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

76 { return "("; }

+ Here is the caller graph for this function:

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

Returns the name of this object.

Definition at line 32 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name.

Referenced by 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::PRMSlotChain< GUM_SCALAR >::__copyLastElt(), gum::prm::PRMSystem< GUM_SCALAR >::__groundAttr(), gum::prm::PRMSystem< GUM_SCALAR >::__groundPotential(), gum::prm::PRMSystem< GUM_SCALAR >::__groundRef(), gum::prm::PRMClass< GUM_SCALAR >::__inheritClass(), gum::prm::PRMInterface< GUM_SCALAR >::__overloadAttribute(), 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::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::prm::PRMClass< 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::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::getArray(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant(), gum::prm::PRMObject::isInstance(), gum::prm::PRMObject::name(), gum::prm::PRMType< GUM_SCALAR >::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMType< GUM_SCALAR >::operator!=(), gum::prm::PRMObject::operator!=(), operator<<(), gum::prm::PRMType< GUM_SCALAR >::operator==(), gum::prm::PRMObject::operator==(), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::PRMClass< GUM_SCALAR >::overload(), 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(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode(), and gum::prm::PRMAggregate< double >::str2enum().

32 { return __name; }
std::string __name
Definition: PRMObject.h:197
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 wath you are doing !

Definition at line 36 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name, and gum::prm::PRMObject::name().

36 { __name = name; }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
std::string __name
Definition: PRMObject.h:197

+ Here is the call graph for this function:

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 55 of file PRMClassElement_tpl.h.

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

Referenced by gum::prm::PRMClassElement< double >::isParameter().

+ Here is the caller graph for this function:

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 46 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name, and gum::prm::PRMObject::name().

Referenced by gum::prm::PRMObject::isInstance().

46  {
47  return __name != obj.name();
48  }
std::string __name
Definition: PRMObject.h:197

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 62 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

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

62  {
63  GUM_ERROR(FatalError, "illegal call to gum::ReferenceSlot copy operator.");
64  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the caller graph for this function:

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 40 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name, and gum::prm::PRMObject::name().

Referenced by gum::prm::PRMObject::isInstance().

40  {
41  return __name == obj.name();
42  }
std::string __name
Definition: PRMObject.h:197

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static 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 77 of file PRMObject.h.

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

77 { return ")"; }

+ Here is the caller graph for this function:

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 65 of file PRMClassElement_tpl.h.

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

Referenced by gum::prm::PRMClass< GUM_SCALAR >::__addCastDescendants(), gum::prm::PRMInterface< GUM_SCALAR >::__addCastDescendants(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::SVED< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< GUM_SCALAR >::__groundPotential(), gum::prm::PRMSystem< GUM_SCALAR >::__groundRef(), gum::prm::PRMClass< GUM_SCALAR >::__inheritClass(), gum::prm::PRMClass< GUM_SCALAR >::__overloadAggregate(), gum::prm::PRMInterface< GUM_SCALAR >::__overloadAttribute(), 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::__print_attribute__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::_getIOFlag(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::_setIOFlag(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::belongsTo(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

65  {
66  return _safeName;
67  }
std::string _safeName
The safe name of this PRMClassElement.

+ Here is the caller graph for this function:

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 60 of file PRMClassElement_tpl.h.

References gum::prm::PRMClassElement< GUM_SCALAR >::__id, and gum::prm::PRMClassElement< GUM_SCALAR >::id().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::__addCastDescendants(), gum::prm::PRMInterface< GUM_SCALAR >::__addCastDescendants(), gum::prm::PRMClass< GUM_SCALAR >::__checkInterface(), gum::prm::PRMClass< GUM_SCALAR >::__checkRefInterface(), gum::prm::PRMSlotChain< GUM_SCALAR >::__copyLastElt(), gum::prm::PRMClass< GUM_SCALAR >::__inheritClass(), gum::prm::PRMInterface< GUM_SCALAR >::__inheritInterface(), gum::prm::PRMInterface< GUM_SCALAR >::__overloadAttribute(), 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::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClass< GUM_SCALAR >::inheritReferenceSlots(), and gum::prm::PRMClassElement< double >::isParameter().

60  {
61  __id = id;
62  }
NodeId __id
The node&#39;s id of this element.
NodeId id() const
Returns the NodeId of this element in it&#39;s class DAG.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 74 of file PRMReferenceSlot_tpl.h.

References gum::prm::PRMReferenceSlot< GUM_SCALAR >::__slotType.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::__buildSlotChain(), gum::prm::PRMFactory< GUM_SCALAR >::__checkInterfaceImplementation(), gum::prm::PRMInterface< GUM_SCALAR >::__checkOverloadLegality(), gum::prm::PRMClass< GUM_SCALAR >::__checkRefInterface(), gum::prm::PRMClass< GUM_SCALAR >::__overloadReference(), gum::prm::PRMInstance< GUM_SCALAR >::add(), and gum::prm::PRMSlotChain< GUM_SCALAR >::end().

74  {
75  return __slotType;
76  }
PRMClassElementContainer< GUM_SCALAR > & __slotType
The type of this PRMReferenceSlot.

+ Here is the caller graph for this function:

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 80 of file PRMReferenceSlot_tpl.h.

References gum::prm::PRMReferenceSlot< GUM_SCALAR >::__slotType.

80  {
81  return __slotType;
82  }
PRMClassElementContainer< GUM_SCALAR > & __slotType
The type of this PRMReferenceSlot.
template<typename GUM_SCALAR >
INLINE PRMType< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::type ( )
virtual

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

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

Definition at line 90 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

90  {
91  GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.");
92  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
template<typename GUM_SCALAR >
INLINE const PRMType< GUM_SCALAR > & gum::prm::PRMReferenceSlot< GUM_SCALAR >::type ( ) const
virtual

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

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

Definition at line 96 of file PRMReferenceSlot_tpl.h.

References GUM_ERROR.

96  {
97  GUM_ERROR(OperationNotAllowed, "This is a ReferenceSlot.");
98  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

Member Data Documentation

template<typename GUM_SCALAR>
bool gum::prm::PRMReferenceSlot< GUM_SCALAR >::__isArray
private

Flag indicating if this slot is an array.

Definition at line 164 of file PRMReferenceSlot.h.

Referenced by gum::prm::PRMReferenceSlot< GUM_SCALAR >::isArray().

template<typename GUM_SCALAR>
PRMClassElementContainer< GUM_SCALAR >& gum::prm::PRMReferenceSlot< GUM_SCALAR >::__slotType
private

The type of this PRMReferenceSlot.

Definition at line 161 of file PRMReferenceSlot.h.

Referenced by gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType().


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