A PRMSlotChain represents a sequence of gum::prm::PRMClassElement<GUM_SCALAR> where the n-1 first gum::prm::PRMClassElement<GUM_SCALAR> are gum::prm::PRMReferenceSlot and the last gum::prm::PRMClassElement<GUM_SCALAR> an gum::prm::PRMAttribute or an gum::prm::PRMAggregate. More...

#include <PRMObject.h>

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

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

Public Member Functions
Constructors & destructor
	PRMSlotChain (const std::string &name, const Sequence< PRMClassElement< GUM_SCALAR > * > &chain)
	Default constructor. More...

	PRMSlotChain (Sequence< PRMClassElement< GUM_SCALAR > * > *chain, const std::string &name)
	Tweak constructor. More...

	PRMSlotChain (const PRMSlotChain< GUM_SCALAR > &source)
	Copy constructor. More...

virtual	~PRMSlotChain ()
	Destructor. More...

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

virtual PRMType &	type ()
	This is similar to the following call: this->lastElt().type() More...

virtual const PRMType &	type () const
	This is similar to the following call: this->lastElt().type() More...

virtual const Potential< GUM_SCALAR > &	cpf () const
	This is similar to the following call: this->lastElt().cpf() More...

bool	isMultiple () const
	Return true if this slot chain contains at least one multiple reference slot. More...

PRMClassElementContainer< GUM_SCALAR > &	end ()
	Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends. More...

const PRMClassElementContainer< GUM_SCALAR > &	end () const
	Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends. More...

PRMClassElement< GUM_SCALAR > &	lastElt ()
	Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate. More...

const PRMClassElement< GUM_SCALAR > &	lastElt () const
	Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate. More...

Sequence< PRMClassElement< GUM_SCALAR > *> &	chain ()
	Return the sequence representing the chain of elements in this PRMSlotChain. More...

const Sequence< PRMClassElement< GUM_SCALAR > *> &	chain () const
	Return the sequence representing the chain of elements in this PRMSlotChain. More...

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

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

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

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

Private members of PRMSlotChain.
Sequence< PRMClassElement< GUM_SCALAR > >	chain__
	The sequence of PRMClassElement<GUM_SCALAR> composing the slot chain. More...

bool	isMultiple__
	Flag indicating if this slot chain is multiple or not. More...

void	copyLastElt__ ()
	Copy the last element, this prevents unwanted DuplicateElement exceptions. More...

Detailed Description

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

A PRMSlotChain represents a sequence of gum::prm::PRMClassElement<GUM_SCALAR> where the n-1 first gum::prm::PRMClassElement<GUM_SCALAR> are gum::prm::PRMReferenceSlot and the last gum::prm::PRMClassElement<GUM_SCALAR> an gum::prm::PRMAttribute or an gum::prm::PRMAggregate.

A PRMSlotChain behaves as an gum::prm::PRMAttribute or an gum::prm::PRMAggregate (depending the gum::prm::PRMClassElement<GUM_SCALAR> type of it's last element) regarding the following methods: gum::prm::PRMClassElement<GUM_SCALAR>::type() and gum::prm::PRMClassElement<GUM_SCALAR>::cpf().

Definition at line 228 of file PRMObject.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

◆ PRMSlotChain() [1/3]

template<typename GUM_SCALAR>

gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain	(	const std::string &	name,
		const Sequence< PRMClassElement< GUM_SCALAR > * > &	chain
	)

Default constructor.

Chain's n-1 first elements must be PRMReferenceSlot and the last element must either be an PRMAttribute or an PRMAggregate.

Warning: the last element in chain is copied !

Parameters

name	The name of this PRMSlotChain.
chain	The chain of gum::prm::PRMClassElement<GUM_SCALAR> in this PRMSlotChain.

Exceptions

OperationNotAllowed	Raised if the chain contains less than two PRMClassElement<GUM_SCALAR>.
WrongClassElement<GUM_SCALAR>	Raised contains invalid PRMClassElement<GUM_SCALAR>.

Definition at line 34 of file PRMSlotChain_tpl.h.

                                                                 :
         PRMClassElement< GUM_SCALAR >(name),
         chain__(new Sequence< PRMClassElement< GUM_SCALAR >* >(chain)),
         isMultiple__(false) {
       GUM_CONSTRUCTOR(PRMSlotChain);
 
       if (chain__->size() < 2) {
         GUM_ERROR(OperationNotAllowed,
                   "chain must contain at least two ClassElement");
       }
 
       for (Size i = 0; i < chain__->size() - 1; ++i) {
         if (chain__->atPos(i)->elt_type()
             != PRMClassElement< GUM_SCALAR >::prm_refslot) {
           GUM_ERROR(WrongClassElement, "illegal ClassElement in chain");
         } else {
           isMultiple__
              = isMultiple__
             || static_cast< PRMReferenceSlot< GUM_SCALAR >* >(chain__->atPos(i))
                   ->isArray();
         }
       }
 
       copyLastElt__();
 
       this->safeName_ = PRMObject::LEFT_CAST() + lastElt().type().name()
                       + PRMObject::RIGHT_CAST() + name;
       this->lastElt().type().variable().setName(name);
     }

◆ PRMSlotChain() [2/3]

template<typename GUM_SCALAR>

gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain	(	Sequence< PRMClassElement< GUM_SCALAR > * > *	chain,
		const std::string &	name
	)

Tweak constructor.

Chain's n-1 first elements must be PRMReferenceSlot and the last element must either be an PRMAttribute or an PRMAggregate.

Warning: the last element in chain is copied !

Parameters

name	The name of this PRMSlotChain.
chain	The chain given to this PRMSlotChain, it is deleted when PRMSlotChain::~PRMSlotChain() is called.

Exceptions

OperationNotAllowed	Raised if the chain contains less than two PRMClassElement<GUM_SCALAR>.
WrongClassElement<GUM_SCALAR>	Raised contains invalid PRMClassElement<GUM_SCALAR>.

Definition at line 69 of file PRMSlotChain_tpl.h.

                                                        :
         PRMSlotChain(name, *chain) {
       // No need to
       // GUM_CONSTRUCTOR(PRMSlotChain);
 
       // if (chain__->size() < 2) {
       //  GUM_ERROR(OperationNotAllowed,
       //            "chain must containt at least two PRMClassElement");
       //}
 
       // for (Size i = 0; i < chain__->size() - 1; ++i) {
       //  if (not(chain__->atPos(i)->elt_type() !=
       //          PRMClassElement<GUM_SCALAR>::prm_refslot)) {
       //    GUM_ERROR(WrongClassElement, "illegal PRMClassElement in chain");
       //  } else {
       //    isMultiple__ =
       //        isMultiple__ or
       //        static_cast<PRMReferenceSlot<GUM_SCALAR>
       //        *>(chain__->atPos(i))->isArray();
       //  }
       //}
 
       //__copyLastElt();
       // this->safeName_ = PRMObject::LEFT_CAST() + lastElt().type().name() +
       // PRMObject::RIGHT_CAST() + name;
     }

◆ PRMSlotChain() [3/3]

template<typename GUM_SCALAR>

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

Copy constructor.

This creates a copy of the slot chain.

Definition at line 145 of file PRMSlotChain_tpl.h.

                                                  :
         PRMClassElement< GUM_SCALAR >(source.name()),
         chain__(new Sequence< PRMClassElement< GUM_SCALAR >* >(source.chain())),
         isMultiple__(source.isMultiple()) {
       GUM_CONS_CPY(PRMSlotChain);
       copyLastElt__();
     }

◆ ~PRMSlotChain()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 138 of file PRMSlotChain_tpl.h.

                                               {
       GUM_DESTRUCTOR(PRMSlotChain);
       delete chain__->back();
       delete chain__;
     }

Member Function Documentation

◆ addChild()

template<typename GUM_SCALAR>

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

virtual

See gum::PRMClassElement<GUM_SCALAR>::addChild_().

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

Definition at line 226 of file PRMSlotChain_tpl.h.

227 {}

◆ addParent()

template<typename GUM_SCALAR>

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

virtual

See gum::PRMClassElement<GUM_SCALAR>::addParent_().

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

Definition at line 222 of file PRMSlotChain_tpl.h.

223 {}

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

◆ chain() [1/2]

template<typename GUM_SCALAR >

INLINE Sequence< PRMClassElement< GUM_SCALAR > *> & gum::prm::PRMSlotChain< GUM_SCALAR >::chain ( )

Return the sequence representing the chain of elements in this PRMSlotChain.

Definition at line 211 of file PRMSlotChain_tpl.h.

                                              {
       return *chain__;
     }

◆ chain() [2/2]

template<typename GUM_SCALAR >

INLINE const Sequence< PRMClassElement< GUM_SCALAR > *> & gum::prm::PRMSlotChain< GUM_SCALAR >::chain ( ) const

Return the sequence representing the chain of elements in this PRMSlotChain.

Definition at line 217 of file PRMSlotChain_tpl.h.

                                                          {
       return *chain__;
     }

◆ copyLastElt__()

template<typename GUM_SCALAR >

void gum::prm::PRMSlotChain< GUM_SCALAR >::copyLastElt__ ( )

private

Copy the last element, this prevents unwanted DuplicateElement exceptions.

Definition at line 99 of file PRMSlotChain_tpl.h.

                                                    {
       PRMClassElement< GUM_SCALAR >* new_elt = nullptr;
 
       switch (chain__->back()->elt_type()) {
         case PRMClassElement< GUM_SCALAR >::prm_attribute: {
           auto old_attr
              = static_cast< const PRMAttribute< GUM_SCALAR >* >(chain__->back());
 
           Bijection< const DiscreteVariable*, const DiscreteVariable* > bij;
           for (auto var: old_attr->cpf().variablesSequence()) {
             if (var != &(old_attr->type().variable())) { bij.insert(var, var); }
           }
 
           new_elt = old_attr->copy(bij);
           break;
         }
 
         case PRMClassElement< GUM_SCALAR >::prm_aggregate: {
           const PRMAggregate< GUM_SCALAR >* c_agg
              = static_cast< const PRMAggregate< GUM_SCALAR >* >(chain__->back());
           PRMAggregate< GUM_SCALAR >* agg
              = new PRMAggregate< GUM_SCALAR >(c_agg->name(),
                                               c_agg->agg_type(),
                                               c_agg->type(),
                                               c_agg->id());
           new_elt = agg;
           break;
         }
 
         default: {
           GUM_ERROR(WrongClassElement, "last element of chain is not valid");
         }
       }
 
       new_elt->setId(chain__->back()->id());
       chain__->setAtPos(chain__->size() - 1, new_elt);
     }

◆ cpf()

template<typename GUM_SCALAR >

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

virtual

This is similar to the following call: this->lastElt().cpf()

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

Definition at line 178 of file PRMSlotChain_tpl.h.

                                                                                 {
       return chain__->back()->cpf();
     }

◆ elt_type()

template<typename GUM_SCALAR >

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

virtual

See gum::PRMClassElement<GUM_SCALAR>::elt_type().

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

Definition at line 163 of file PRMSlotChain_tpl.h.

                                                   {
       return this->prm_slotchain;
     }

◆ end() [1/2]

template<typename GUM_SCALAR >

INLINE PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::end ( )

Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends.

Definition at line 184 of file PRMSlotChain_tpl.h.

                                            {
       return static_cast< PRMReferenceSlot< GUM_SCALAR >* >(
                 chain__->atPos(chain__->size() - 2))
          ->slotType();
     }

◆ end() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::end ( ) const

Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends.

Definition at line 192 of file PRMSlotChain_tpl.h.

                                                        {
       return static_cast< PRMReferenceSlot< GUM_SCALAR >* >(
                 chain__->atPos(chain__->size() - 2))
          ->slotType();
     }

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

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

virtual

Raise a gum::OperationNotAllowed exception See gum::PRMClassElement<GUM_SCALAR>::getCastDescendant()

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

Definition at line 236 of file PRMSlotChain_tpl.h.

                                                                {
       GUM_ERROR(OperationNotAllowed, "This is a slotchain");
     }

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

◆ isMultiple()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMSlotChain< GUM_SCALAR >::isMultiple ( ) const

Return true if this slot chain contains at least one multiple reference slot.

Definition at line 230 of file PRMSlotChain_tpl.h.

                                                              {
       return isMultiple__;
     }

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

◆ lastElt() [1/2]

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt ( )

Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate.

Definition at line 199 of file PRMSlotChain_tpl.h.

                                                                               {
       return *(chain__->back());
     }

◆ lastElt() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt ( ) const

Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate.

Definition at line 205 of file PRMSlotChain_tpl.h.

                                                            {
       return *(chain__->back());
     }

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

PRMSlotChain< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::operator= ( const PRMSlotChain< GUM_SCALAR > & source )

private

Copy operator. Don't use it.

Definition at line 155 of file PRMSlotChain_tpl.h.

                                                  {
       GUM_ERROR(FatalError,
                 "Illegal call to gum::SlotChain<GUM_SCALAR> copy constructor.");
     }

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

INLINE PRMType & gum::prm::PRMSlotChain< GUM_SCALAR >::type ( )

virtual

This is similar to the following call: this->lastElt().type()

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

Definition at line 168 of file PRMSlotChain_tpl.h.

                                                      {
       return chain__->back()->type();
     }

◆ type() [2/2]

template<typename GUM_SCALAR >

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

virtual

This is similar to the following call: this->lastElt().type()

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

Definition at line 173 of file PRMSlotChain_tpl.h.

                                                                  {
       return chain__->back()->type();
     }

Member Data Documentation

◆ chain__

template<typename GUM_SCALAR>

Sequence< PRMClassElement< GUM_SCALAR >* >* gum::prm::PRMSlotChain< GUM_SCALAR >::chain__

private

The sequence of PRMClassElement<GUM_SCALAR> composing the slot chain.

Definition at line 209 of file PRMSlotChain.h.

◆ isMultiple__

template<typename GUM_SCALAR>

bool gum::prm::PRMSlotChain< GUM_SCALAR >::isMultiple__

private

Flag indicating if this slot chain is multiple or not.

Definition at line 212 of file PRMSlotChain.h.

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

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

agrum/PRM/elements/PRMObject.h
agrum/PRM/elements/PRMSlotChain.h
agrum/PRM/elements/PRMSlotChain_tpl.h

Public Member Functions

Protected Attributes

Built-in type

Built-in types.

Private members of PRMSlotChain.

Detailed Description

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

Member Enumeration Documentation

◆ ClassElementType

◆ prm_type

Constructor & Destructor Documentation

◆ PRMSlotChain() [1/3]

◆ PRMSlotChain() [2/3]

◆ PRMSlotChain() [3/3]

◆ ~PRMSlotChain()

Member Function Documentation

◆ addChild()

◆ addParent()

◆ cast()

◆ chain() [1/2]

◆ chain() [2/2]

◆ copyLastElt__()

◆ cpf()

◆ elt_type()

◆ end() [1/2]

◆ end() [2/2]

◆ enum2str() [1/2]

◆ enum2str() [2/2]

◆ getCastDescendant()

◆ id()

◆ isAggregate()

◆ isAttribute()

◆ isClass()

◆ isInstance()

◆ isInterface()

◆ isMultiple()

◆ isParameter()

◆ isReferenceSlot()

◆ isSlotChain()

◆ lastElt() [1/2]

◆ lastElt() [2/2]

◆ LEFT_CAST()

◆ name() [1/2]

◆ name() [2/2]

◆ obj_type()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ RIGHT_CAST()

◆ safeName()

◆ setId()

◆ type() [1/2]

◆ type() [2/2]

Member Data Documentation

◆ chain__

◆ isMultiple__

◆ safeName_

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