aGrUM  0.20.3
a C++ library for (probabilistic) graphical models
gum::prm::PRMClassElement< GUM_SCALAR > Class Template Referenceabstract

Abstract class representing an element of PRM class. More...

#include <PRMClassElement.h>

+ Inheritance diagram for gum::prm::PRMClassElement< GUM_SCALAR >:
+ Collaboration diagram for gum::prm::PRMClassElement< GUM_SCALAR >:

Public Member Functions

Constructor & Destructor.
 PRMClassElement (const std::string &name)
 Default constructor of a PRMClassElement. More...
 
 PRMClassElement (const PRMClassElement< GUM_SCALAR > &source)
 Copy constructor. More...
 
virtual ~PRMClassElement ()
 Destructor of this class. 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 void addParent (const PRMClassElement< GUM_SCALAR > &elt)=0
 Add a parent to this element. More...
 
virtual void addChild (const PRMClassElement< GUM_SCALAR > &elt)=0
 Add a child to this element. More...
 
virtual PRMObject::prm_type obj_type () const
 
virtual ClassElementType elt_type () const =0
 Return the type of class element this object is. More...
 
Fast access to random variable's properties
virtual PRMTypetype ()=0
 Return a reference over the gum::PRMType of this class element. More...
 
virtual const PRMTypetype () const =0
 Return a constant reference over the gum::PRMType of this class element. More...
 
virtual PRMAttribute< GUM_SCALAR > * getCastDescendant () const =0
 Returns a proper cast descendant of this PRMAttribute. More...
 
const std::string & safeName () const
 Returns the safe name of this PRMClassElement, if any. More...
 
virtual std::string cast (const PRMType &t) const
 Returns the name of the cast descendant with PRMType t of this PRMClassElement. More...
 
virtual const Potential< GUM_SCALAR > & cpf () const =0
 Return a reference over the gum::Potential of this class element. 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< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMReferenceSlot. More...
 
static INLINE bool isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMAttribute. More...
 
static INLINE bool isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMAggregate. More...
 
static INLINE bool isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMSlotChain. More...
 
static INLINE bool isParameter (const PRMClassElement< GUM_SCALAR > &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 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 std::string enum2str (prm_type type)
 Returns the string representation of a PRMObject. 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::PRMClassElement< GUM_SCALAR >

Abstract class representing an element of PRM class.

All class elements are nodes in the class's DAG and a unique name in their class.

Definition at line 60 of file PRMClassElement.h.

Member Enumeration Documentation

◆ ClassElementType

template<typename GUM_SCALAR>
enum gum::prm::PRMClassElement::ClassElementType

Returns true if obj_ptr is of type PRMReferenceSlot.

Enumerator
prm_attribute 
prm_aggregate 
prm_refslot 
prm_slotchain 
prm_parameter 

Definition at line 94 of file PRMClassElement.h.

◆ prm_type

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

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

Constructor & Destructor Documentation

◆ PRMClassElement() [1/2]

template<typename GUM_SCALAR >
gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement ( const std::string &  name)
explicit

Default constructor of a PRMClassElement.

The PRMClassElement will automatically add itself to c.

Parameters
nameThe name of this element, must be unique in it's class.
Exceptions
DupplicateElementRaised if c contains already an element with the same name.

Definition at line 35 of file PRMClassElement_tpl.h.

35  : PRMObject(name) {
36  GUM_CONSTRUCTOR(PRMClassElement);
37  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:34
PRMClassElement(const std::string &name)
Default constructor of a PRMClassElement.
PRMObject(const std::string &name)
Constructor.
Definition: PRMObject.cpp:42

◆ PRMClassElement() [2/2]

template<typename GUM_SCALAR>
gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement ( const PRMClassElement< GUM_SCALAR > &  source)

Copy constructor.

Definition at line 40 of file PRMClassElement_tpl.h.

40  :
41  PRMObject(source.name()), _id_(source.id()) {
42  GUM_CONS_CPY(PRMClassElement);
43  }
NodeId _id_
The node&#39;s id of this element.
PRMClassElement(const std::string &name)
Default constructor of a PRMClassElement.
PRMObject(const std::string &name)
Constructor.
Definition: PRMObject.cpp:42

◆ ~PRMClassElement()

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

Destructor of this class.

Definition at line 46 of file PRMClassElement_tpl.h.

46  {
47  GUM_DESTRUCTOR(PRMClassElement);
48  }
PRMClassElement(const std::string &name)
Default constructor of a PRMClassElement.

Member Function Documentation

◆ addChild()

◆ addParent()

◆ cast()

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

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.

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

◆ cpf()

template<typename GUM_SCALAR>
virtual const Potential< GUM_SCALAR >& gum::prm::PRMClassElement< GUM_SCALAR >::cpf ( ) const
pure virtual

◆ elt_type()

◆ enum2str() [1/2]

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

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.h.

83  {
84  switch (type) {
85  case prm_type::CLASS:
86  return "PRMType::CLASS";
87 
89  return "PRMType::CLASS_ELT";
90 
91  case prm_type::TYPE:
92  return "PRMType::TYPE";
93 
94  case prm_type::SYSTEM:
95  return "PRMType::SYSTEM";
96 
97  case prm_type::INSTANCE:
98  return "PRMType::INSTANCE";
99 
101  return "PRMType::PRM_INTERFACE";
102 
103  default:
104  return "unknown";
105  }
106  }

◆ enum2str() [2/2]

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

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 103 of file PRMClassElement.h.

103  {
104  switch (type) {
105  case prm_attribute:
106  return "prm_attribute";
107 
108  case prm_aggregate:
109  return "prm_aggregate";
110 
111  case prm_refslot:
112  return "prm_refslot";
113 
114  case prm_slotchain:
115  return "prm_slotchain";
116 
117  case prm_parameter:
118  return "prm_parameter";
119 
120  default:
121  return "unknown";
122  }
123  }
virtual PRMType & type()=0
Return a reference over the gum::PRMType of this class element.

◆ getCastDescendant()

template<typename GUM_SCALAR>
virtual PRMAttribute< GUM_SCALAR >* gum::prm::PRMClassElement< GUM_SCALAR >::getCastDescendant ( ) const
pure virtual

Returns a proper cast descendant of this PRMAttribute.

A cast descendant is an PRMAttribute depending on this one which cast it in this->type().super().

The pointer is not deleted by this PRMAttribute, so delete it yourself after use.

A new cast descendant is created for each call of this method.

Returns
The cast descendant of this PRMAttribute.
Exceptions
OperationNotAllowedRaised if it is not possible to create a cast descendant for this PRMAttribute.

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAggregate< double >, gum::prm::PRMSlotChain< GUM_SCALAR >, gum::prm::PRMSlotChain< double >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMReferenceSlot< double >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMAttribute< double >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMParameter< double >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ id()

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

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

Definition at line 51 of file PRMClassElement_tpl.h.

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

◆ isAggregate()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestatic

Return true if obj is of type PRMAggregate.

Definition at line 136 of file PRMClassElement.h.

136  {
137  return elt.elt_type() == prm_aggregate;
138  }

◆ isAttribute()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestatic

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 131 of file PRMClassElement.h.

131  {
132  return elt.elt_type() == prm_attribute;
133  }

◆ isClass()

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

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

109 { return obj.obj_type() == prm_type::CLASS; }
+ Here is the call graph for this function:

◆ isInstance()

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

Returns true if obj_ptr is of type PRMInstance.

Definition at line 117 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

117  {
118  return obj.obj_type() == prm_type::INSTANCE;
119  }
+ Here is the call graph for this function:

◆ isInterface()

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

Returns true if obj_ptr is of type PRMInterface.

Definition at line 112 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

112  {
113  return obj.obj_type() == prm_type::PRM_INTERFACE;
114  }
+ Here is the call graph for this function:

◆ isParameter()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestatic

Return true if obj is of type PRMParameter.

Definition at line 146 of file PRMClassElement.h.

146  {
147  return elt.elt_type() == prm_parameter;
148  }

◆ isReferenceSlot()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestatic

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 126 of file PRMClassElement.h.

126  {
127  return elt.elt_type() == prm_refslot;
128  }

◆ isSlotChain()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestatic

Return true if obj is of type PRMSlotChain.

Definition at line 141 of file PRMClassElement.h.

141  {
142  return elt.elt_type() == prm_slotchain;
143  }

◆ LEFT_CAST()

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

79 { return "("; }

◆ name() [1/2]

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

Returns the name of this object.

Definition at line 34 of file PRMObject_inl.h.

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

34 { return _name_; }
std::string _name_
Definition: PRMObject.h:205
+ Here is the call graph for this function:

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

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

38 { _name_ = name; }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:34
std::string _name_
Definition: PRMObject.h:205
+ 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
virtual
See also
gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 56 of file PRMClassElement_tpl.h.

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

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

46 { return _name_ != obj.name(); }
std::string _name_
Definition: PRMObject.h:205
+ 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 42 of file PRMObject_inl.h.

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

42 { return _name_ == obj.name(); }
std::string _name_
Definition: PRMObject.h:205
+ Here is the call graph for this function:

◆ RIGHT_CAST()

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

80 { return ")"; }

◆ safeName()

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

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

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

◆ setId()

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

Used to assign the id of this element.

Definition at line 61 of file PRMClassElement_tpl.h.

61  {
62  _id_ = id;
63  }
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.

◆ type() [1/2]

◆ type() [2/2]

Member Data Documentation

◆ _id_

template<typename GUM_SCALAR>
NodeId gum::prm::PRMClassElement< GUM_SCALAR >::_id_
private

The node's id of this element.

Definition at line 269 of file PRMClassElement.h.

◆ safeName_

template<typename GUM_SCALAR>
std::string gum::prm::PRMClassElement< GUM_SCALAR >::safeName_
protected

The safe name of this PRMClassElement.

Definition at line 265 of file PRMClassElement.h.


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