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

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 PRMType &	type ()=0
	Return a reference over the gum::PRMType of this class element. More...
virtual const PRMType &	type () 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 61 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 95 of file PRMClassElement.h.

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

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

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

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

name	The name of this element, must be unique in it's class.

Exceptions

DupplicateElement

Raised if c contains already an element with the same name.

Definition at line 36 of file PRMClassElement_tpl.h.

                                                                        :
        PRMObject(name) {
      GUM_CONSTRUCTOR(PRMClassElement);
    }

PRMClassElement() [2/2]

template<typename GUM_SCALAR>

gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement

(

const PRMClassElement< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 42 of file PRMClassElement_tpl.h.

                                                    :
        PRMObject(source.name()),
        __id(source.id()) {
      GUM_CONS_CPY(PRMClassElement);
    }

~PRMClassElement()

template<typename GUM_SCALAR >

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

virtual

Destructor of this class.

Definition at line 50 of file PRMClassElement_tpl.h.

                                                    {
      GUM_DESTRUCTOR(PRMClassElement);
    }

Member Function Documentation

addChild()

template<typename GUM_SCALAR>

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

pure virtual

Add a child to this element.

This methos is called by gum::Class when a child is added to this element.

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

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

Here is the caller graph for this function:

addParent()

template<typename GUM_SCALAR>

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

pure virtual

Add a parent to this element.

This method is called by gum::Class when en parent is added to this elememnt.

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

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

Here is the caller graph for this function:

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

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

Exceptions

OperationNotAllowed

If the cast is impossible.

Definition at line 76 of file PRMClassElement_tpl.h.

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

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

Here is the caller graph for this function:

cpf()

template<typename GUM_SCALAR>

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

pure virtual

Return a reference over the gum::Potential of this class element.

Exceptions

OperationNotAllowed	Raised if this class element doesn't have any gum::Potential (like a gum::PRMReferenceSlot). Return a constant reference over the gum::Potential of this class element.
OperationNotAllowed	Raised if the class element doesn't have any gum::Potential (like a gum::PRMReferenceSlot).

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::PRMParameter< GUM_SCALAR >, gum::prm::PRMAttribute< double >, gum::prm::PRMParameter< double >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

Here is the caller graph for this function:

elt_type()

template<typename GUM_SCALAR>

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

pure virtual

Return the type of class element this object is.

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

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInterface< double >::__checkOverloadLegality(), gum::prm::PRMClass< double >::__checkOverloadLegality(), gum::prm::PRMFactory< GUM_SCALAR >::__checkStack(), gum::prm::PRMClass< double >::add(), gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::PRMClass< double >::addArc(), gum::prm::PRMClassElement< double >::isAggregate(), gum::prm::PRMClassElement< double >::isAttribute(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClassElement< double >::isReferenceSlot(), gum::prm::PRMClassElement< double >::isSlotChain(), gum::prm::PRMClass< double >::overload(), and gum::prm::PRMInterface< double >::overload().

Here is the caller graph for this function:

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.

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<<().

                                               {
        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";
        }
      }

Here is the caller graph for this function:

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.

                                                       {
        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";
        }
      }

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

OperationNotAllowed

Raised 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 >.

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

Here is the caller graph for this function:

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

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::SVE< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::SVED< GUM_SCALAR >::_marginal(), gum::prm::SVE< GUM_SCALAR >::_marginal(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::addArc(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

                                                          {
      return __id;
    }

Here is the caller graph for this function:

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

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData().

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

Here is the caller graph for this function:

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

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

isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 102 of file PRMObject.h.

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

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

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

Here is the call graph for this function:

Here is the caller 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 112 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().

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

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

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

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

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

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

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

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

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

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

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

Here is the caller graph for this function:

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.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

{ return "("; }

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

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

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable(), gum::prm::PRMClass< double >::__addIOInterfaceFlags(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInstance< GUM_SCALAR >::__addReferingInstance(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMFactory< GUM_SCALAR >::__checkInterfaceImplementation(), gum::prm::PRMClass< double >::__checkInterfaces(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkRawCPT(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMClass< double >::__checkRefInterfaces(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkRuleCPTSumsTo1(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMSystem< double >::__groundAttr(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMSystem< double >::__groundRef(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__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< double >::add(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::isCastDescendant(), gum::prm::PRMObject::isInstance(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMType::operator!=(), gum::prm::PRMObject::operator!=(), operator<<(), gum::prm::PRMType::operator==(), gum::prm::PRMObject::operator==(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< double >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), gum::prm::PRMFactory< GUM_SCALAR >::startSystem(), and gum::prm::PRMAggregate< double >::str2enum().

{ return __name; }

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 wath you are doing !

Definition at line 39 of file PRMObject_inl.h.

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

{ __name = 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

virtual

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 60 of file PRMClassElement_tpl.h.

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

                                                                           {
      return prm_type::CLASS_ELT;
    }

Here is the caller 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 49 of file PRMObject_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller 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 43 of file PRMObject_inl.h.

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

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

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

Here is the call graph for this function:

Here is the caller 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.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

{ return ")"; }

Here is the caller graph for this function:

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

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

                                                                          {
      return _safeName;
    }

Here is the caller graph for this function:

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

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMInterface< double >::__inheritInterface(), gum::prm::PRMInterface< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadAttribute(), gum::prm::PRMClass< double >::__overloadParameter(), gum::prm::PRMClass< double >::__overloadReference(), gum::prm::PRMInterface< double >::__overloadReferenceSlot(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::inheritParameters(), gum::prm::PRMClass< double >::inheritReferenceSlots(), gum::prm::PRMClass< double >::inheritSlotChains(), and gum::prm::PRMClassElement< double >::isParameter().

                                                              {
      __id = id;
    }

Here is the caller graph for this function:

type() [1/2]

template<typename GUM_SCALAR>

virtual PRMType& gum::prm::PRMClassElement< GUM_SCALAR >::type ( )

pure virtual

Return a reference over the gum::PRMType of this class element.

Exceptions

OperationNotAllowed

Raised if this class element doesn't have any gum::Potential (like a gum::PRMReferenceSlot).

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 >.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addNode(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMInterface< double >::__checkOverloadLegality(), gum::prm::PRMClass< double >::__checkOverloadLegality(), gum::prm::PRMSystem< double >::__groundAgg(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::SVED< GUM_SCALAR >::__initLiftedNodes(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClass< double >::isCastDescendant(), and gum::prm::PRMClassElement< double >::isParameter().

Here is the caller graph for this function:

type() [2/2]

template<typename GUM_SCALAR>

virtual const PRMType& gum::prm::PRMClassElement< GUM_SCALAR >::type ( ) const

pure virtual

Return a constant reference over the gum::PRMType of this class element.

Exceptions

OperationNotAllowed

Raised if this class element doesn't have any gum::Potential (like a gum::PRMReferenceSlot).

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 >.

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

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

---

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

• agrum/PRM/elements/PRMClassElement.h
• agrum/PRM/elements/PRMClassElement_tpl.h