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

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

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

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

Public Member Functions
Constructors & destructor
	PRMSlotChain (std::string_view name, const Sequence< PRMClassElement< GUM_SCALAR > * > &chain)
	Default constructor.
	PRMSlotChain (Sequence< PRMClassElement< GUM_SCALAR > * > *chain, std::string_view name)
	Tweak constructor.
	PRMSlotChain (const PRMSlotChain< GUM_SCALAR > &source)
	Copy constructor.
	~PRMSlotChain () override
	Destructor.
Getters & setters
PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const override
	See gum::PRMClassElement<GUM_SCALAR>::elt_type().
PRMType &	type () override
	This is similar to the following call: this->lastElt().type().
const PRMType &	type () const override
	This is similar to the following call: this->lastElt().type().
const Tensor< GUM_SCALAR > &	cpf () const override
	This is similar to the following call: this->lastElt().cpf().
bool	isMultiple () const
	Return true if this slot chain contains at least one multiple reference slot.
PRMClassElementContainer< GUM_SCALAR > &	end ()
	Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends.
const PRMClassElementContainer< GUM_SCALAR > &	end () const
	Returns the PRMClassElement<GUM_SCALAR>Container over which this slot chain ends.
PRMClassElement< GUM_SCALAR > &	lastElt ()
	Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate.
const PRMClassElement< GUM_SCALAR > &	lastElt () const
	Returns the last element of the slot chain, typically this is an gum::PRMAttribute or a gum::PRMAggregate.
Sequence< PRMClassElement< GUM_SCALAR > * > &	chain ()
	Return the sequence representing the chain of elements in this PRMSlotChain.
const Sequence< PRMClassElement< GUM_SCALAR > * > &	chain () const
	Return the sequence representing the chain of elements in this PRMSlotChain.
void	addParent (const PRMClassElement< GUM_SCALAR > &elt) override
	See gum::PRMClassElement<GUM_SCALAR>::addParent_().
void	addChild (const PRMClassElement< GUM_SCALAR > &elt) override
	See gum::PRMClassElement<GUM_SCALAR>::addChild_().
PRMAttribute< GUM_SCALAR > *	getCastDescendant () const override
	Raise a gum::OperationNotAllowed exception See gum::PRMClassElement<GUM_SCALAR>::getCastDescendant().
Getters & setters
NodeId	id () const
	Returns the NodeId of this element in it's class DAG.
virtual void	setId (NodeId id)
	Used to assign the id of this element.
PRMObject::prm_type	obj_type () const override
Fast access to random variable's properties
const std::string &	safeName () const
	Returns the safe name of this PRMClassElement, if any.
virtual std::string	cast (const PRMType &t) const
	Returns the name of the cast descendant with PRMType t of this PRMClassElement.
Getters & setters.
const std::string &	name () const
	Returns the name of this object.
void	name (std::string_view name)
	Change the name of the PRM Object.
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique).
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique).

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

Private Member Functions
PRMSlotChain &	operator= (const PRMSlotChain &source)
	Copy operator. Don't use it.

Private Attributes
NodeId	_id_
	The node's id of this element.
Private members.
std::string	_name_

Private members of PRMSlotChain.
Sequence< PRMClassElement< GUM_SCALAR > * > *	_chain_
	The sequence of PRMClassElement<GUM_SCALAR> composing the slot chain.
bool	_isMultiple_
	Flag indicating if this slot chain is multiple or not.
void	_copyLastElt_ ()
	Copy the last element, this prevents unwanted DuplicateElement exceptions.

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.
static INLINE bool	isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMReferenceSlot.
static INLINE bool	isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMAttribute.
static INLINE bool	isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMAggregate.
static INLINE bool	isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMSlotChain.
static INLINE bool	isParameter (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMParameter.

Built-in types.
enum class	prm_type : char {   ALL , CLASS , PRM_INTERFACE , CLASS_ELT ,   TYPE , SYSTEM , 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.
static std::string	LEFT_CAST ()
	Enumeration of the different types of objects handled by a PRM.
static std::string	RIGHT_CAST ()
	Enumeration of the different types of objects handled by a PRM.
static INLINE bool	isClass (const PRMObject &obj)
	Returns true if obj_ptr is of type Class.
static INLINE bool	isInterface (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInterface.
static INLINE bool	isInstance (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInstance.

Detailed Description

template<GUM_Numeric 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 91 of file PRMSlotChain.h.

Member Enumeration Documentation

ClassElementType

template<GUM_Numeric 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 109 of file PRMClassElement.h.

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

prm_type

enum class 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 90 of file PRMObject.h.

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

Constructor & Destructor Documentation

PRMSlotChain() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain	(	std::string_view	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 56 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())
                            .append(name);
      this->lastElt().type().variable().setName(name);
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMSlotChain(), _chain_, _copyLastElt_(), _isMultiple_, chain(), GUM_ERROR, gum::prm::PRMReferenceSlot< GUM_SCALAR >::isArray(), lastElt(), gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::prm_refslot, gum::prm::PRMObject::RIGHT_CAST(), and gum::prm::PRMClassElement< GUM_SCALAR >::safeName_.

Referenced by PRMSlotChain(), PRMSlotChain(), PRMSlotChain(), ~PRMSlotChain(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

PRMSlotChain() [2/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain	(	Sequence< PRMClassElement< GUM_SCALAR > * > *	chain,
		std::string_view	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 87 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;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMSlotChain(), chain(), and gum::prm::PRMObject::name().

Here is the call graph for this function:

PRMSlotChain() [3/3]

template<GUM_Numeric 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 159 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_();
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMSlotChain(), _chain_, _copyLastElt_(), _isMultiple_, chain(), isMultiple(), and gum::prm::PRMObject::name().

Here is the call graph for this function:

~PRMSlotChain()

template<GUM_Numeric GUM_SCALAR>

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

override

Destructor.

Definition at line 152 of file PRMSlotChain_tpl.h.

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

References PRMSlotChain(), and _chain_.

Here is the call graph for this function:

Member Function Documentation

_copyLastElt_()

template<GUM_Numeric GUM_SCALAR>

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

private

Copy the last element, this prevents unwanted DuplicateElement exceptions.

Definition at line 115 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);
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), _chain_, gum::prm::PRMAggregate< GUM_SCALAR >::agg_type(), GUM_ERROR, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::BijectionImplementation< T1, T2, Gen >::insert(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::prm_aggregate, gum::prm::PRMClassElement< GUM_SCALAR >::prm_attribute, gum::prm::PRMClassElement< GUM_SCALAR >::setId(), and gum::prm::PRMAggregate< GUM_SCALAR >::type().

Referenced by PRMSlotChain(), and PRMSlotChain().

Here is the call graph for this function:

Here is the caller graph for this function:

addChild()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 230 of file PRMSlotChain_tpl.h.

{}

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

Here is the call graph for this function:

addParent()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 227 of file PRMSlotChain_tpl.h.

{}

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

Here is the call graph for this function:

cast()

template<GUM_Numeric GUM_SCALAR>

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 93 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")
      }
    }

References GUM_ERROR, gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMObject::RIGHT_CAST(), and type().

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant().

Here is the call graph for this function:

Here is the caller graph for this function:

chain() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

(

)

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

Definition at line 217 of file PRMSlotChain_tpl.h.

                                                                                  {
      return *_chain_;
    }

References _chain_.

Referenced by PRMSlotChain(), PRMSlotChain(), PRMSlotChain(), gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_(), and gum::prm::PRMFactory< GUM_SCALAR >::_retrieveInputs_().

Here is the caller graph for this function:

chain() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 222 of file PRMSlotChain_tpl.h.

                                                                                              {
      return *_chain_;
    }

References _chain_.

cpf()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 190 of file PRMSlotChain_tpl.h.

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

References _chain_.

elt_type()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 175 of file PRMSlotChain_tpl.h.

                                                   {
      return this->prm_slotchain;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::prm_slotchain.

end() [1/2]

template<GUM_Numeric GUM_SCALAR>

PRMClassElementContainer< GUM_SCALAR > & gum::prm::PRMSlotChain< GUM_SCALAR >::end

(

)

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

Definition at line 195 of file PRMSlotChain_tpl.h.

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

References _chain_, and gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType().

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addArcs_(), gum::prm::PRMInstance< GUM_SCALAR >::add(), and gum::prm::PRMClass< GUM_SCALAR >::addArc().

Here is the call graph for this function:

Here is the caller graph for this function:

end() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 201 of file PRMSlotChain_tpl.h.

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

References _chain_, and gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType().

Here is the call graph for this function:

enum2str() [1/2]

template<GUM_Numeric GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType type )

staticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 102 of file PRMClassElement_tpl.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";
      }
    }

References prm_aggregate, prm_attribute, prm_parameter, prm_refslot, prm_slotchain, and type().

Here is the call graph for this function:

enum2str() [2/2]

INLINE std::string gum::prm::PRMObject::enum2str ( prm_type type )

staticinherited

Returns the string representation of a PRMObject.

Definition at line 75 of file PRMObject_inl.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";
      }
    }

References CLASS, CLASS_ELT, INSTANCE, PRM_INTERFACE, SYSTEM, and TYPE.

Referenced by gum::prm::operator<<().

Here is the caller graph for this function:

getCastDescendant()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 238 of file PRMSlotChain_tpl.h.

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

References GUM_ERROR.

id()

template<GUM_Numeric GUM_SCALAR>

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

inherited

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

Definition at line 73 of file PRMClassElement_tpl.h.

                                                   {
      return _id_;
    }

References _id_.

Referenced by PRMClassElement(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::SVE< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::InstanceBayesNet< GUM_SCALAR >::_init_(), gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::addArc(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::SVE< GUM_SCALAR >::posterior_(), gum::prm::SVED< GUM_SCALAR >::posterior_(), setId(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

isAggregate()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > & elt )

staticinherited

Return true if obj is of type PRMAggregate.

Definition at line 129 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_aggregate.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAggregator(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

isAttribute()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > & elt )

staticinherited

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 124 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_attribute.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMSystem< double >::_groundRef_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

isClass()

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

staticinherited

Returns true if obj_ptr is of type Class.

Definition at line 93 of file PRMObject_inl.h.

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

References PRMObject().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::scope(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

isInstance()

INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject & obj )

staticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 101 of file PRMObject_inl.h.

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

References PRMObject(), INSTANCE, and obj_type().

Here is the call graph for this function:

isInterface()

INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject & obj )

staticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 97 of file PRMObject_inl.h.

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

isMultiple()

template<GUM_Numeric GUM_SCALAR>

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

(

)

const

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

Definition at line 233 of file PRMSlotChain_tpl.h.

                                                      {
      return _isMultiple_;
    }

References _isMultiple_.

Referenced by PRMSlotChain(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), and gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_().

Here is the caller graph for this function:

isParameter()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > & elt )

staticinherited

Return true if obj is of type PRMParameter.

Definition at line 139 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_parameter.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkParameters_(), and gum::prm::PRMClass< GUM_SCALAR >::add().

Here is the call graph for this function:

Here is the caller graph for this function:

isReferenceSlot()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > & elt )

staticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 119 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_refslot.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkAssignments_(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkIncrements_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkReferenceSlot_(), gum::prm::PRMInterface< GUM_SCALAR >::add(), and gum::prm::PRMFactory< GUM_SCALAR >::setReferenceSlot().

Here is the call graph for this function:

Here is the caller graph for this function:

isSlotChain()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > & elt )

staticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 134 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_slotchain.

Referenced by gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::PRMFactory< GUM_SCALAR >::_retrieveInputs_(), gum::prm::PRMClass< GUM_SCALAR >::add(), and gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound().

Here is the call graph for this function:

Here is the caller graph for this function:

lastElt() [1/2]

template<GUM_Numeric GUM_SCALAR>

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 207 of file PRMSlotChain_tpl.h.

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

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), and _chain_.

Referenced by PRMSlotChain(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addArcs_(), gum::prm::PRMInstance< GUM_SCALAR >::_addReferingInstance_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMFactory< GUM_SCALAR >::_retrieveInputs_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), and gum::prm::PRMClass< GUM_SCALAR >::addArc().

Here is the call graph for this function:

Here is the caller graph for this function:

lastElt() [2/2]

template<GUM_Numeric GUM_SCALAR>

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 212 of file PRMSlotChain_tpl.h.

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

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), and _chain_.

Here is the call graph for this function:

LEFT_CAST()

INLINE std::string gum::prm::PRMObject::LEFT_CAST ( )

staticinherited

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

{ return "("; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

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

{ return _name_; }

References _name_.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute(), gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), PRMObject(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSystem< GUM_SCALAR >::PRMSystem(), gum::prm::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::SVE< GUM_SCALAR >::_addDelayedVariable_(), gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_addReferingInstance_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMFactory< GUM_SCALAR >::_checkInterfaceImplementation_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRawCPT_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRuleCPTSumsTo1_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundAgg_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundTensor_(), gum::prm::PRMSystem< double >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMSystem< GUM_SCALAR >::exists(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::getArray(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMSystem< GUM_SCALAR >::isArray(), gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::isInstance(), name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), operator!=(), operator<<(), gum::prm::PRMClass< GUM_SCALAR >::operator=(), operator==(), gum::prm::PRMType::operator==(), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainterConstIterator, gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::startSystem().

name() [2/2]

INLINE void gum::prm::PRMObject::name ( std::string_view name )

inherited

Change the name of the PRM Object.

Warning

Don't do this unless you know what you are doing !

Definition at line 61 of file PRMObject_inl.h.

{ _name_ = name; }

References _name_, and name().

Here is the call graph for this function:

obj_type()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtualinherited

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 78 of file PRMClassElement_tpl.h.

                                                                    {
      return prm_type::CLASS_ELT;
    }

References gum::prm::PRMObject::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 69 of file PRMObject_inl.h.

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

References PRMObject(), _name_, and name().

Here is the call graph for this function:

operator=()

template<GUM_Numeric 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 169 of file PRMSlotChain_tpl.h.

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

References PRMSlotChain(), and GUM_ERROR.

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

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

References PRMObject(), _name_, and name().

Here is the call graph for this function:

RIGHT_CAST()

INLINE std::string gum::prm::PRMObject::RIGHT_CAST ( )

staticinherited

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

{ return ")"; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

Here is the caller graph for this function:

safeName()

template<GUM_Numeric GUM_SCALAR>

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

                                                                   {
      return safeName_;
    }

References safeName_.

Referenced by gum::prm::__print_attribute__(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttributeCPF_(), gum::prm::SVED< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAggregate_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::belongsTo(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInnerNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setIOFlag_(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

setId()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMClassElement< GUM_SCALAR >::setId ( NodeId id )

virtualinherited

Used to assign the id of this element.

Definition at line 83 of file PRMClassElement_tpl.h.

                                                       {
      _id_ = id;
    }

References _id_, and id().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), and gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates().

Here is the call graph for this function:

Here is the caller graph for this function:

type() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 185 of file PRMSlotChain_tpl.h.

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

References _chain_.

type() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

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

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

Definition at line 180 of file PRMSlotChain_tpl.h.

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

References _chain_.

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), and gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_().

Here is the caller graph for this function:

Member Data Documentation

_chain_

template<GUM_Numeric 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 216 of file PRMSlotChain.h.

Referenced by PRMSlotChain(), PRMSlotChain(), ~PRMSlotChain(), _copyLastElt_(), chain(), chain(), cpf(), end(), end(), lastElt(), lastElt(), type(), and type().

_id_

template<GUM_Numeric GUM_SCALAR>

NodeId gum::prm::PRMClassElement< GUM_SCALAR >::_id_

privateinherited

The node's id of this element.

Definition at line 254 of file PRMClassElement.h.

Referenced by PRMClassElement(), id(), and setId().

_isMultiple_

template<GUM_Numeric GUM_SCALAR>

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

private

Flag indicating if this slot chain is multiple or not.

Definition at line 219 of file PRMSlotChain.h.

Referenced by PRMSlotChain(), PRMSlotChain(), and isMultiple().

_name_

std::string gum::prm::PRMObject::_name_

privateinherited

Definition at line 193 of file PRMObject.h.

Referenced by PRMObject(), PRMObject(), PRMObject(), name(), name(), operator!=(), operator=(), and operator==().

safeName_

template<GUM_Numeric GUM_SCALAR>

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

protectedinherited

The safe name of this PRMClassElement.

Definition at line 250 of file PRMClassElement.h.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), and safeName().

---

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