PRMAttribute is a member of a Class in a PRM. More...

#include <PRMAttribute.h>

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

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

Public Member Functions
Constructors & destructor
	PRMAttribute (const std::string &name)
	Destructor. More...

virtual	~PRMAttribute ()
	Destructor. More...

Getters & setters
virtual PRMAttribute< GUM_SCALAR > *	newFactory (const PRMClass< GUM_SCALAR > &c) const =0
	See gum::PRMClassElement::elt_type(). More...

virtual PRMAttribute< GUM_SCALAR > *	copy (Bijection< const DiscreteVariable , const DiscreteVariable > bij) const =0
	See gum::PRMClassElement::elt_type(). More...

virtual void	copyCpf (const Bijection< const DiscreteVariable , const DiscreteVariable > &bif, const PRMAttribute< GUM_SCALAR > &source)=0
	See gum::PRMClassElement::elt_type(). More...

virtual PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const =0
	See gum::PRMClassElement::elt_type(). More...

virtual PRMType &	type ()=0
	See gum::PRMClassElement::type(). More...

virtual const PRMType &	type () const =0
	See gum::PRMClassElement::type(). More...

virtual const Potential< GUM_SCALAR > &	cpf () const =0
	See gum::PRMClassElement::cpf(). More...

virtual void	addParent (const PRMClassElement< GUM_SCALAR > &elt)=0
	See gum::PRMClassElement::addParent_(). More...

virtual void	addChild (const PRMClassElement< GUM_SCALAR > &elt)=0
	See gum::PRMClassElement::addChild_(). More...

virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const =0
	Returns a proper cast descendant of this PRMAttribute. More...

virtual void	setAsCastDescendant (PRMAttribute< GUM_SCALAR > *attr)=0
	Define attr as a cast descendant of this PRMAttribute. More...

virtual void	becomeCastDescendant (PRMType &subtype)=0
	Change this attribute to be a cast descendant of a an attribute with type subtype. More...

virtual void	swap (const PRMType &old_type, const PRMType &new_type)=0
	Swap old_type with new_type in the PRMClassElement cpt. More...

virtual void	overload (PRMAttribute< GUM_SCALAR > *source)
	Set this as overload of source (necessayr to preserver internal pointers for MultiDims). 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 &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...

Protected Member Functions
	PRMAttribute (const PRMAttribute< GUM_SCALAR > &source)

virtual PRMType *	type_ ()=0

virtual void	type_ (PRMType *t)=0

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	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::PRMAttribute< GUM_SCALAR >

PRMAttribute is a member of a Class in a PRM.

A PRMAttribute is defined by its name, its containing class, its type and by a Conditional Probability Function (aka CPF but represented by a Potential).

An attribute in a PRM is the equivalent of a random variable in a Bayesian network.

This class is constructed by a gum::PRMFactory and is deleted by its gum::Class.

Built-in copies (copy constructor and copy operator) are illegal due to various problems raised by redondant information.

See also: PRM PRMFactory Class PRMClassElement PRMType Potential

Definition at line 60 of file PRMAttribute.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 94 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 68 of file PRMObject.h.

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

Constructor & Destructor Documentation

◆ PRMAttribute() [1/2]

template<typename GUM_SCALAR >

gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute ( const std::string & name )

explicit

Destructor.

Definition at line 33 of file PRMAttribute_tpl.h.

                                                                   :
         PRMClassElement< GUM_SCALAR >(name) {
       GUM_CONSTRUCTOR(PRMAttribute);
     }

◆ ~PRMAttribute()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 46 of file PRMAttribute_tpl.h.

                                               {
       GUM_DESTRUCTOR(PRMAttribute);
     }

◆ PRMAttribute() [2/2]

template<typename GUM_SCALAR>

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

protected

Definition at line 39 of file PRMAttribute_tpl.h.

                                                                                      :
         PRMClassElement< GUM_SCALAR >(source) {
       GUM_CONS_CPY(PRMAttribute);
       GUM_ERROR(OperationNotAllowed, "Cannot copy Attributes")
     }

Member Function Documentation

◆ addChild()

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::addChild_().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMFuncAttribute< GUM_SCALAR >.

◆ addParent()

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::addParent_().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMFuncAttribute< GUM_SCALAR >.

◆ becomeCastDescendant()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMAttribute< GUM_SCALAR >::becomeCastDescendant ( PRMType & subtype )

pure virtual

Change this attribute to be a cast descendant of a an attribute with type subtype.

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ 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 71 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")
       }
     }

◆ copy()

template<typename GUM_SCALAR>

virtual PRMAttribute< GUM_SCALAR >* gum::prm::PRMAttribute< GUM_SCALAR >::copy ( Bijection< const DiscreteVariable *, const DiscreteVariable * > bij ) const

pure virtual

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ copyCpf()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMAttribute< GUM_SCALAR >::copyCpf	(	const Bijection< const DiscreteVariable , const DiscreteVariable > &	bif,
		const PRMAttribute< GUM_SCALAR > &	source
	)

pure virtual

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ cpf()

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::cpf().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ elt_type()

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::elt_type().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

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

◆ enum2str() [2/2]

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

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

                                                           {
       return _id_;
     }

◆ isAggregate()

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

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

◆ isAttribute()

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

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

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

gum::prm::PRMObject::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().

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

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

                                                            {
         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 )

inlinestaticinherited

Return true if obj is of type PRMParameter.

Definition at line 146 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 )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 126 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 )

inlinestaticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 141 of file PRMClassElement.h.

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

◆ 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_; }

gum::prm::PRMObject::_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; }

gum::prm::PRMObject::name

const std::string & name() const

Returns the name of this object.

Definition: PRMObject_inl.h:34

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ newFactory()

template<typename GUM_SCALAR>

virtual PRMAttribute< GUM_SCALAR >* gum::prm::PRMAttribute< GUM_SCALAR >::newFactory ( const PRMClass< GUM_SCALAR > & c ) const

pure virtual

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

                                                                            {
       return prm_type::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 46 of file PRMObject_inl.h.

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

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

gum::prm::PRMObject::_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(); }

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ overload()

template<typename GUM_SCALAR>

void gum::prm::PRMAttribute< GUM_SCALAR >::overload ( PRMAttribute< GUM_SCALAR > * source )

virtual

Set this as overload of source (necessayr to preserver internal pointers for MultiDims).

Definition at line 51 of file PRMAttribute_tpl.h.

                                                                                 {
       auto old_type = this->type_();
       this->type_(source->type_());
       source->type_(old_type);
     }

◆ 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

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

                                                                           {
       return safeName_;
     }

◆ setAsCastDescendant()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMAttribute< GUM_SCALAR >::setAsCastDescendant ( PRMAttribute< GUM_SCALAR > * attr )

pure virtual

Define attr as a cast descendant of this PRMAttribute.

When overloading an inherited PRMAttribute using of subtype of it, it is necessary to change the inherited PRMAttribute CPF to make it a proper cast descendant.

Furthermore it is necessary to change the DiscreteVariable used by this PRMAttribute's super PRMType in order to have the same pointers in both super PRMType (i.e. this->type().super().variable()) and the cast descendant CPF (i.e. attr->cpf()).

This can only be done if attr PRMType is a direct subtype of this PRMAttribute PRMType (i.e. this->type().super() == attr->type()).

Parameters

attr	The PRMAttribute which is transformed to be this PRMAttribute cast descendant.

Exceptions

OperationNotAllowed	Raised if this PRMAttribute can not have any cast descendant.
PRMTypeError	Raised if attr's PRMType is not a direct descendant of this PRMAttribute's PRMType.

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

                                                               {
       _id_ = id;
     }

◆ swap()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMAttribute< GUM_SCALAR >::swap	(	const PRMType &	old_type,
		const PRMType &	new_type
	)

pure virtual

Swap old_type with new_type in the PRMClassElement cpt.

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ type() [1/2]

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::type().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ type() [2/2]

template<typename GUM_SCALAR>

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

pure virtual

See gum::PRMClassElement::type().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ type_() [1/2]

template<typename GUM_SCALAR>

virtual PRMType* gum::prm::PRMAttribute< GUM_SCALAR >::type_ ( )

protectedpure virtual

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ type_() [2/2]

template<typename GUM_SCALAR>

virtual void gum::prm::PRMAttribute< GUM_SCALAR >::type_ ( PRMType * t )

protectedpure virtual

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

Member Data Documentation

◆ safeName_

template<typename GUM_SCALAR>

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

protectedinherited

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:

agrum/PRM/elements/PRMAttribute.h
agrum/PRM/elements/PRMAttribute_tpl.h

Public Member Functions

Protected Attributes

Protected Member Functions

Built-in type

Built-in types.

Detailed Description

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

Member Enumeration Documentation

◆ ClassElementType

◆ prm_type

Constructor & Destructor Documentation

◆ PRMAttribute() [1/2]

◆ ~PRMAttribute()

◆ PRMAttribute() [2/2]

Member Function Documentation

◆ addChild()

◆ addParent()

◆ becomeCastDescendant()

◆ cast()

◆ copy()

◆ copyCpf()

◆ cpf()

◆ elt_type()

◆ enum2str() [1/2]

◆ enum2str() [2/2]

◆ getCastDescendant()

◆ id()

◆ isAggregate()

◆ isAttribute()

◆ isClass()

◆ isInstance()

◆ isInterface()

◆ isParameter()

◆ isReferenceSlot()

◆ isSlotChain()

◆ LEFT_CAST()

◆ name() [1/2]

◆ name() [2/2]

◆ newFactory()

◆ obj_type()

◆ operator!=()

◆ operator==()

◆ overload()

◆ RIGHT_CAST()

◆ safeName()

◆ setAsCastDescendant()

◆ setId()

◆ swap()

◆ type() [1/2]

◆ type() [2/2]

◆ type_() [1/2]

◆ type_() [2/2]

Member Data Documentation

◆ safeName_

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