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

#include <PRMParameter.h>

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

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

Public Member Functions
Constructor & destructor.
	PRMParameter (const std::string &name, ParameterType type, GUM_SCALAR value)
	Constructor used by gum::Class. More...

virtual	~PRMParameter ()
	Destructor. More...

Getters & setters
virtual PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const
	See gum::PRMClassElement::elt_type(). More...

GUM_SCALAR	value () const
	See gum::PRMClassElement::elt_type(). More...

void	value (GUM_SCALAR value)
	See gum::PRMClassElement::elt_type(). More...

ParameterType	valueType () const
	See gum::PRMClassElement::elt_type(). More...

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

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

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

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

void	addParent (const gum::prm::PRMClassElement< GUM_SCALAR > &)
	See gum::PRMClassElement::addParent(). More...

void	addChild (const gum::prm::PRMClassElement< GUM_SCALAR > &)
	See gum::PRMClassElement::addChild(). More...

virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const
	Raise a gum::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 &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...

Public Types
enum	ParameterType { INT, REAL }

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

Protected Member Functions
	PRMParameter (const PRMParameter< GUM_SCALAR > &source)
	Copy constructor. Don't use it. More...

PRMParameter< GUM_SCALAR > &	operator= (const PRMParameter< GUM_SCALAR > &from)
	Copy operator. Don't use it. 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	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::PRMParameter< GUM_SCALAR >

PRMParameter is a member of a Class in a PRM.

See also: PRM PRMFactory Class PRMClassElement

Definition at line 51 of file PRMParameter.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
       };

◆ ParameterType

template<typename GUM_SCALAR>

enum gum::prm::PRMParameter::ParameterType

Enumerator
INT
REAL

Definition at line 53 of file PRMParameter.h.

       {
         INT,
         REAL
       };

◆ 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

◆ PRMParameter() [1/2]

template<typename GUM_SCALAR>

gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter	(	const std::string &	name,
		ParameterType	type,
		GUM_SCALAR	value
	)

Constructor used by gum::Class.

Parameters

name
type
value

Definition at line 33 of file PRMParameter_tpl.h.

                                                                        :
         PRMClassElement< GUM_SCALAR >(name),
         type__(type), value__(value) {
       GUM_CONSTRUCTOR(PRMParameter);
       this->safeName_ = name;
     }

◆ ~PRMParameter()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 57 of file PRMParameter_tpl.h.

                                               {
       GUM_DESTRUCTOR(PRMParameter);
     }

◆ PRMParameter() [2/2]

template<typename GUM_SCALAR>

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

protected

Copy constructor. Don't use it.

Definition at line 43 of file PRMParameter_tpl.h.

                                                  :
         PRMClassElement< GUM_SCALAR >(source.name()),
         type__(source.valueType()), value__(source.value()) {
       GUM_ERROR(OperationNotAllowed, "cannot copy Paramter<GUM_SCALAR");
     }

Member Function Documentation

◆ addChild()

template<typename GUM_SCALAR>

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

virtual

See gum::PRMClassElement::addChild().

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

Definition at line 110 of file PRMParameter_tpl.h.

                                                    {
       GUM_ERROR(OperationNotAllowed, "Parameters can not have children");
     }

◆ addParent()

template<typename GUM_SCALAR>

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

virtual

See gum::PRMClassElement::addParent().

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

Definition at line 104 of file PRMParameter_tpl.h.

                                                    {
       GUM_ERROR(OperationNotAllowed, "Parameters can not have parents");
     }

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

◆ cpf() [1/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > & gum::prm::PRMParameter< GUM_SCALAR >::cpf ( )

virtual

See gum::PRMClassElement::cpf().

Definition at line 94 of file PRMParameter_tpl.h.

                                                              {
       GUM_ERROR(OperationNotAllowed, "Parameters do not have a cpf");
     }

◆ cpf() [2/2]

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::cpf().

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

Definition at line 99 of file PRMParameter_tpl.h.

                                                                          {
       GUM_ERROR(OperationNotAllowed, "Parameters do not have a cpf");
     }

◆ elt_type()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::elt_type().

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

Definition at line 63 of file PRMParameter_tpl.h.

                                                   {
       return PRMClassElement< GUM_SCALAR >::ClassElementType::prm_parameter;
     }

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

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

virtual

Raise a gum::OperationNotAllowed See gum::PRMClassElement::getCastDescendant()

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

Definition at line 117 of file PRMParameter_tpl.h.

                                                            {
       GUM_ERROR(OperationNotAllowed, "Parameters can have cast descendants");
     }

◆ 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 54 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 137 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 132 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().

                                                        {
         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 119 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 114 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 147 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 127 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 142 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:207

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__

std::string name__

Definition: PRMObject.h:207

gum::prm::PRMObject::name

const std::string & name() const

Returns the name of this object.

Definition: PRMObject_inl.h:34

Here is the call graph for this function:

◆ obj_type()

template<typename GUM_SCALAR >

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

virtualinherited

See also: gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 59 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 48 of file PRMObject_inl.h.

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

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

Here is the call graph for this function:

◆ operator=()

template<typename GUM_SCALAR>

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

protected

Copy operator. Don't use it.

Definition at line 51 of file PRMParameter_tpl.h.

                                                {
       GUM_ERROR(OperationNotAllowed, "cannot copy Paramter<GUM_SCALAR");
     }

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

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

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

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

                                                                           {
       return safeName_;
     }

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

                                                               {
       id__ = id;
     }

◆ type() [1/2]

template<typename GUM_SCALAR >

PRMType & gum::prm::PRMParameter< GUM_SCALAR >::type ( )

virtual

See gum::PRMClassElement::type().

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

Definition at line 84 of file PRMParameter_tpl.h.

                                               {
       GUM_ERROR(OperationNotAllowed, "Parameters do not have a type");
     }

◆ type() [2/2]

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement::type().

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

Definition at line 89 of file PRMParameter_tpl.h.

                                                           {
       GUM_ERROR(OperationNotAllowed, "Parameters do not have a type");
     }

◆ value() [1/2]

template<typename GUM_SCALAR >

GUM_SCALAR gum::prm::PRMParameter< GUM_SCALAR >::value ( ) const

See gum::PRMClassElement::elt_type().

Definition at line 68 of file PRMParameter_tpl.h.

                                                        {
       return value__;
     }

◆ value() [2/2]

template<typename GUM_SCALAR>

void gum::prm::PRMParameter< GUM_SCALAR >::value ( GUM_SCALAR value )

See gum::PRMClassElement::elt_type().

Definition at line 73 of file PRMParameter_tpl.h.

                                                            {
       value__ = value;
     }

◆ valueType()

template<typename GUM_SCALAR >

PRMParameter< GUM_SCALAR >::ParameterType gum::prm::PRMParameter< GUM_SCALAR >::valueType ( ) const

See gum::PRMClassElement::elt_type().

Definition at line 79 of file PRMParameter_tpl.h.

                                                    {
       return type__;
     }

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

◆ type__

template<typename GUM_SCALAR>

ParameterType gum::prm::PRMParameter< GUM_SCALAR >::type__

private

Definition at line 129 of file PRMParameter.h.

◆ value__

template<typename GUM_SCALAR>

GUM_SCALAR gum::prm::PRMParameter< GUM_SCALAR >::value__

private

Definition at line 131 of file PRMParameter.h.

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

agrum/PRM/elements/PRMParameter.h
agrum/PRM/elements/PRMParameter_tpl.h

Public Member Functions

Public Types

Protected Attributes

Protected Member Functions

Built-in type

Built-in types.

Detailed Description

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

Member Enumeration Documentation

◆ ClassElementType

◆ ParameterType

◆ prm_type

Constructor & Destructor Documentation

◆ PRMParameter() [1/2]

◆ ~PRMParameter()

◆ PRMParameter() [2/2]

Member Function Documentation

◆ addChild()

◆ addParent()

◆ cast()

◆ cpf() [1/2]

◆ cpf() [2/2]

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

◆ obj_type()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ RIGHT_CAST()

◆ safeName()

◆ setId()

◆ type() [1/2]

◆ type() [2/2]

◆ value() [1/2]

◆ value() [2/2]

◆ valueType()

Member Data Documentation

◆ safeName_

◆ type__

◆ value__

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