An PRMInterface is implemented by a Class<GUM_SCALAR> and defines a set of PRMReferenceSlot<GUM_SCALAR> and PRMAttribute<GUM_SCALAR> which the implementing Class<GUM_SCALAR> must contain. More...

#include <PRMInterface.h>

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

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

Public Member Functions
Constructor & destructor.
	PRMInterface (std::string_view name)
	Default constructor.
	PRMInterface (std::string_view name, PRMInterface< GUM_SCALAR > &super, bool delayInheritance=false)
	Constructor for building a subclass of super.
	PRMInterface (const PRMInterface< GUM_SCALAR > &source)
	Copy constructor.
	~PRMInterface () override
	Destructor.
Graphical model getters and setters
PRMObject::prm_type	obj_type () const override
	Implementation of pure virtual method of PRMObject.
PRMClassElement< GUM_SCALAR > &	get (NodeId id) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).
const PRMClassElement< GUM_SCALAR > &	get (NodeId id) const override
	Se gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).
void	addArc (std::string_view tail, std::string_view head) override
	An Interfance doesn't have any arc, this will raise an OperationNotAllowed exception.
PRMClassElement<GUM_SCALAR> getters and setters
bool	isOutputNode (const PRMClassElement< GUM_SCALAR > &elt) const override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).
PRMClassElement< GUM_SCALAR > &	get (std::string_view name) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).
const PRMClassElement< GUM_SCALAR > &	get (std::string_view name) const override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).
const Set< PRMAttribute< GUM_SCALAR > * > &	attributes () const
	Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>.
const Set< PRMReferenceSlot< GUM_SCALAR > * > &	referenceSlots () const
	Returns the set of PRMAggregate of this Class<GUM_SCALAR>.
NodeId	add (PRMClassElement< GUM_SCALAR > *elt) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::add(PRMClassElement<GUM_SCALAR>*).
NodeId	overload (PRMClassElement< GUM_SCALAR > *elt) override
	Add a new PRMClassElement<GUM_SCALAR> which overload an inherited PRMClassElement<GUM_SCALAR>.
Inheritance methods
bool	isSubTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const override
	Test if this PRMInterface is a sub PRMInterface of cec.
PRMInterface< GUM_SCALAR > &	super ()
	Returns the superInterface of this PRMInterface.
const PRMInterface< GUM_SCALAR > &	super () const
	Returns the superInterface of this PRMInterface.
Set< PRMClass< GUM_SCALAR > * > &	implementations ()
	Returns the set of Class<GUM_SCALAR> implementing this PRMInterface.
const Set< PRMClass< GUM_SCALAR > * > &	implementations () const
	Returns the set of Class<GUM_SCALAR> implementing this PRMInterface.
void	inheritInterface ()
	Inherits from this interface super interface, this should only be done when this inteface inheritance was delayed.
Getters & setters operators
PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).
const PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id) const override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).
PRMClassElement< GUM_SCALAR > &	operator[] (std::string_view name) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).
const PRMClassElement< GUM_SCALAR > &	operator[] (std::string_view name) const override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).
Getters on the gum::PRMClassElement<GUM_SCALAR>.
virtual bool	belongsTo (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if elt belongs to this PRMClassElementContainer.
virtual bool	exists (std::string_view name) const
	Returns true if a member with the given name exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.
virtual bool	isInputNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an input node.
virtual void	setInputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the input flag value of id at b.
virtual void	setOutputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the output flag value of id at b.
virtual bool	isInnerNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an inner node.
Graphical operator
virtual bool	exists (NodeId id) const
	Returns true if a member with the given id exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.
virtual const DAG &	containerDag () const
	Returns the gum::DAG of this PRMClassElementContainer.
Inheritance getters and setters
virtual bool	isSuperTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const
	Test if this PRMClassElementContainer is a super type of cec.
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 Member Functions
const DAG &	dag_ () const override
	Returns a constant reference over this PRMInterface's DAG.
DAG &	dag_ () override
	Returns a non constant reference over this PRMInterface's DAG.
void	findAllSubtypes_ (Set< PRMClassElementContainer< GUM_SCALAR > * > &set) override
	Fills set with all the subtypes of this PRMInterface, this includes extensions and implementations.
void	updateDescendants_ (const PRMClassElement< GUM_SCALAR > &elt) override
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>(const PRMClassElement<GUM_SCALAR>&).
virtual std::pair< bool, bool > &	getIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt)
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>.
virtual const std::pair< bool, bool > &	getIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>.
virtual void	setIOFlag_ (const PRMClassElement< GUM_SCALAR > &elt, const std::pair< bool, bool > &flags)
	Defines the IO flags of a PRMClassElement<GUM_SCALAR>.
virtual void	copyIOFlags_ (const PRMClassElementContainer< GUM_SCALAR > &c)
	Copy the IO Flags of c in this PRMClassElementContainer.

Private Member Functions
PRMInterface< GUM_SCALAR > &	operator= (const PRMInterface< GUM_SCALAR > &source)
	Copy operator. Don't use it.
void	_inheritInterface_ (const PRMInterface< GUM_SCALAR > &i)
	Proceed with the copy of i in this.

Private Attributes
HashTable< std::string, std::pair< bool, bool > >	_IOFlags_
	input / output flags, useful when inheriting or copying.
Graphical model members
DAG	_dag_
	The dag representing dependencies between formal attributes and slots.
NodeProperty< PRMClassElement< GUM_SCALAR > * >	_nodeIdMap_
	Mapping between node's id and their name (being an attribute or a slot). Used for fast access to a member given it's node id.
PRMClassElement<GUM_SCALAR> members
HashTable< std::string, PRMClassElement< GUM_SCALAR > * >	_nameMap_
	Mapping between a member's name and itself. Used for fast access to a member given it's name.
Set< PRMAttribute< GUM_SCALAR > * >	_attributes_
	The sequence of PRMAttribute<GUM_SCALAR>s.
Set< PRMReferenceSlot< GUM_SCALAR > * >	_referenceSlots_
	The sequence of PRMReferenceSlot<GUM_SCALAR>.
Private members.
std::string	_name_

Friends
class	PRMClass< GUM_SCALAR >

Iterators
using	ClassEltIterator = typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::iterator
using	const_ClassEltIterator
ClassEltIterator	begin ()
const ClassEltIterator &	end ()
const_ClassEltIterator	begin () const
const const_ClassEltIterator &	end () const

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	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 std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject.
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.

Inheritance members
PRMInterface< GUM_SCALAR > *	_superInterface_
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.
Set< PRMClass< GUM_SCALAR > * >	_implementations_
	The set of Class<GUM_SCALAR> which implements this PRMInterface.
Set< PRMInterface< GUM_SCALAR > * >	_extensions_
	The set of Class<GUM_SCALAR> which implements this PRMInterface.
void	_addImplementation_ (PRMClass< GUM_SCALAR > *c)
	Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface.
void	_addExtension_ (PRMInterface< GUM_SCALAR > *c)
	Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface.
bool	_checkOverloadLegality_ (const PRMClassElement< GUM_SCALAR > overloaded, const PRMClassElement< GUM_SCALAR > overloader)
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.
void	_overloadAttribute_ (PRMAttribute< GUM_SCALAR > overloader, PRMAttribute< GUM_SCALAR > overloaded)
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.
void	_overloadReferenceSlot_ (PRMReferenceSlot< GUM_SCALAR > overloader, PRMReferenceSlot< GUM_SCALAR > overloaded)
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.
void	_addCastDescendants_ (PRMAttribute< GUM_SCALAR > start, PRMAttribute< GUM_SCALAR > end)
	The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::prm::PRMInterface< GUM_SCALAR >

An PRMInterface is implemented by a Class<GUM_SCALAR> and defines a set of PRMReferenceSlot<GUM_SCALAR> and PRMAttribute<GUM_SCALAR> which the implementing Class<GUM_SCALAR> must contain.

See also: PRM Class<GUM_SCALAR> PRMClassElement<GUM_SCALAR>

Definition at line 82 of file PRMInterface.h.

Member Typedef Documentation

◆ ClassEltIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInterface< GUM_SCALAR >::ClassEltIterator = typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::iterator

Definition at line 297 of file PRMInterface.h.

◆ const_ClassEltIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInterface< GUM_SCALAR >::const_ClassEltIterator

Initial value:

typename NodeProperty< PRMClassElement< GUM_SCALAR >* >::const_iterator

gum::NodeProperty

HashTable< NodeId, VAL > NodeProperty

Property on graph elements.

Definition graphElements.h:407

Definition at line 301 of file PRMInterface.h.

Member Enumeration Documentation

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

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

Constructor & Destructor Documentation

◆ PRMInterface() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface ( std::string_view name )

explicit

Default constructor.

Parameters

name	The interface name.

Definition at line 57 of file PRMInterface_tpl.h.

                                                                :
        PRMClassElementContainer< GUM_SCALAR >(name), _superInterface_(0) {
      GUM_CONSTRUCTOR(PRMInterface);
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), PRMInterface(), _superInterface_, and gum::prm::PRMObject::name().

Referenced by PRMInterface(), PRMInterface(), PRMInterface(), ~PRMInterface(), _addExtension_(), _inheritInterface_(), isSubTypeOf(), operator=(), PRMClass< GUM_SCALAR >, super(), and super().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PRMInterface() [2/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface	(	std::string_view	name,
		PRMInterface< GUM_SCALAR > &	super,
		bool	delayInheritance = false )

Constructor for building a subclass of super.

Parameters

name	The sub-interface name.
super	The super PRMInterface of this.
delayInheritance	If true, inheritance will be delayed.

Definition at line 63 of file PRMInterface_tpl.h.

                                                                                           :
        PRMClassElementContainer< GUM_SCALAR >(name), _superInterface_(&super) {
      GUM_CONSTRUCTOR(PRMInterface);
      if (!delayInheritance) { _inheritInterface_(super); }
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), PRMInterface(), _inheritInterface_(), _superInterface_, gum::prm::PRMObject::name(), and super().

Here is the call graph for this function:

◆ PRMInterface() [3/3]

template<GUM_Numeric GUM_SCALAR>

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

Copy constructor.

Definition at line 72 of file PRMInterface_tpl.h.

                                                                                     :
        PRMClassElementContainer< GUM_SCALAR >(source.name()), _dag_(source._dag_),
        _superInterface_(source._superInterface_) {
      GUM_CONS_CPY(PRMInterface);
      GUM_ERROR(FatalError, "don't copy an interface")
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), PRMInterface(), _dag_, _superInterface_, GUM_ERROR, and gum::prm::PRMObject::name().

Here is the call graph for this function:

◆ ~PRMInterface()

template<GUM_Numeric GUM_SCALAR>

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

override

Destructor.

Definition at line 80 of file PRMInterface_tpl.h.

                                              {
      GUM_DESTRUCTOR(PRMInterface);
 
      for (const auto& elt: _nodeIdMap_) {
        delete elt.second;
      }
    }

References PRMInterface(), and _nodeIdMap_.

Here is the call graph for this function:

Member Function Documentation

◆ _addCastDescendants_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_	(	PRMAttribute< GUM_SCALAR > *	start,
		PRMAttribute< GUM_SCALAR > *	end )

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 250 of file PRMInterface_tpl.h.

                                                                                           {
      PRMAttribute< GUM_SCALAR >* parent = start;
      PRMAttribute< GUM_SCALAR >* child  = nullptr;
 
      while (parent->type().superType() != end->type()) {
        child = parent->getCastDescendant();
        child->setId(nextNodeId());
        _dag_.addNodeWithId(child->id());
        _nodeIdMap_.insert(child->id(), child);
        // Only use child's safe name when adding to the name map!
        _nameMap_.insert(child->safeName(), child);
        _attributes_.insert(child);
        // Do ! use Class<GUM_SCALAR>::insertArc(), child's CPF is already
        // initialized properly
        parent = child;
      }
 
      parent->setAsCastDescendant(end);
    }

References _attributes_, _dag_, _nameMap_, _nodeIdMap_, end(), gum::prm::PRMAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::nextNodeId(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), gum::prm::PRMAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMClassElement< GUM_SCALAR >::setId(), gum::prm::PRMType::superType(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

Referenced by _overloadAttribute_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _addExtension_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_addExtension_ ( PRMInterface< GUM_SCALAR > * c )

private

Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface.

Definition at line 374 of file PRMInterface_tpl.h.

                                                                                 {
      _extensions_.insert(i);
    }

References PRMInterface(), and _extensions_.

Here is the call graph for this function:

◆ _addImplementation_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_addImplementation_ ( PRMClass< GUM_SCALAR > * c )

private

Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface.

Definition at line 369 of file PRMInterface_tpl.h.

                                                                                  {
      _implementations_.insert(c);
    }

References _implementations_, and PRMClass< GUM_SCALAR >.

Here is the call graph for this function:

◆ _checkOverloadLegality_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMInterface< GUM_SCALAR >::_checkOverloadLegality_	(	const PRMClassElement< GUM_SCALAR > *	overloaded,
		const PRMClassElement< GUM_SCALAR > *	overloader )

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 272 of file PRMInterface_tpl.h.

                                                         {
      if (overloaded->elt_type() != overloader->elt_type()) { return false; }
 
      if (overloaded->elt_type() == PRMClassElement< GUM_SCALAR >::prm_attribute) {
        if (!overloader->type().isSubTypeOf(overloaded->type())) { return false; }
      } else if (overloaded->elt_type() == PRMClassElement< GUM_SCALAR >::prm_refslot) {
        auto ref_overloader = static_cast< const PRMReferenceSlot< GUM_SCALAR >* >(overloader);
        auto ref_overloaded = static_cast< const PRMReferenceSlot< GUM_SCALAR >* >(overloaded);
        if (!ref_overloader->slotType().isSubTypeOf(ref_overloaded->slotType())) { return false; }
      } else {
        return false;
      }
      return true;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::elt_type(), gum::prm::PRMType::isSubTypeOf(), gum::prm::PRMClassElement< GUM_SCALAR >::prm_attribute, gum::prm::PRMClassElement< GUM_SCALAR >::prm_refslot, gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType(), and gum::prm::PRMClassElement< GUM_SCALAR >::type().

Referenced by overload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _inheritInterface_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_inheritInterface_ ( const PRMInterface< GUM_SCALAR > & i )

private

Proceed with the copy of i in this.

Definition at line 94 of file PRMInterface_tpl.h.

                                                                                           {
      // Copying attributes
      for (const auto i_attr: i._attributes_) {
        auto attr = new PRMScalarAttribute< GUM_SCALAR >(i_attr->name(), i_attr->type());
        attr->setId(i_attr->id());
        _nodeIdMap_.insert(attr->id(), attr);
        _attributes_.insert(attr);
 
        if (i._nameMap_[i_attr->name()] == i._nameMap_[i_attr->safeName()]) {
          _nameMap_.insert(attr->name(), attr);
        }
 
        _nameMap_.insert(attr->safeName(), attr);
        _dag_.addNodeWithId(attr->id());
      }
 
      // Copying reference slots
      for (const auto i_ref: i._referenceSlots_) {
        auto ref = new PRMReferenceSlot< GUM_SCALAR >(
            i_ref->name(),
            const_cast< PRMClassElementContainer< GUM_SCALAR >& >(i_ref->slotType()),
            i_ref->isArray());
 
        ref->setId(i_ref->id());
        _nodeIdMap_.insert(ref->id(), ref);
        _referenceSlots_.insert(ref);
 
        if (i._nameMap_.exists(ref->name())) { _nameMap_.insert(ref->name(), ref); }
 
        _nameMap_.insert(ref->safeName(), ref);
        _dag_.addNodeWithId(ref->id());
      }
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), PRMInterface(), _attributes_, _dag_, _nameMap_, _nodeIdMap_, and _referenceSlots_.

Referenced by PRMInterface(), and inheritInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _overloadAttribute_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_	(	PRMAttribute< GUM_SCALAR > *	overloader,
		PRMAttribute< GUM_SCALAR > *	overloaded )

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 208 of file PRMInterface_tpl.h.

                                                                                                 {
      if (overloader->type() != overloaded->type()) {
        overloader->setId(nextNodeId());
        _dag_.addNodeWithId(overloader->id());
        _nodeIdMap_.insert(overloader->id(), overloader);
        _nameMap_[overloader->name()] = overloader;
        _nameMap_.insert(overloader->safeName(), overloader);
        _attributes_.insert(overloader);
        _addCastDescendants_(overloader, overloaded);
      } else {
        overloader->setId(overloaded->id());
        _nodeIdMap_[overloader->id()]     = overloader;
        _nameMap_[overloader->name()]     = overloader;
        _nameMap_[overloader->safeName()] = overloader;
        _attributes_.erase(overloaded);
        _attributes_.insert(overloader);
        // Swapping types, ugly but necessary to preserve the
        // PRMType<GUM_SCALAR>
        // pointer of overloaded
        overloader->overload(overloaded);
        delete overloaded;
      }
    }

References _addCastDescendants_(), _attributes_, _dag_, _nameMap_, _nodeIdMap_, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), gum::prm::nextNodeId(), gum::prm::PRMAttribute< GUM_SCALAR >::overload(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), gum::prm::PRMClassElement< GUM_SCALAR >::setId(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

Referenced by overload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _overloadReferenceSlot_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_	(	PRMReferenceSlot< GUM_SCALAR > *	overloader,
		PRMReferenceSlot< GUM_SCALAR > *	overloaded )

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 234 of file PRMInterface_tpl.h.

                                                    {
      // Adding overloading reference
      overloader->setId(overloaded->id());
      _nodeIdMap_[overloader->id()] = overloader;
      _nameMap_[overloader->name()] = overloader;
      _nameMap_.insert(overloader->safeName(), overloader);
      _referenceSlots_.insert(overloader);
      // Removing overloaded PRMReferenceSlot<GUM_SCALAR>
      _referenceSlots_.erase(overloaded);
      _nameMap_.erase(overloaded->safeName());
      delete overloaded;
    }

References _nameMap_, _nodeIdMap_, _referenceSlots_, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), and gum::prm::PRMClassElement< GUM_SCALAR >::setId().

Referenced by overload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

template<GUM_Numeric GUM_SCALAR>

NodeId gum::prm::PRMInterface< GUM_SCALAR >::add ( PRMClassElement< GUM_SCALAR > * elt )

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::add(PRMClassElement<GUM_SCALAR>*).

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

Definition at line 129 of file PRMInterface_tpl.h.

                                                                             {
      if (_nameMap_.exists(elt->name())) {
        GUM_ERROR(DuplicateElement,
                  "name '" << elt->name() << "' is already used by another ClassElement");
      }
 
      if (PRMClassElement< GUM_SCALAR >::isAttribute(*elt)) {
        PRMAttribute< GUM_SCALAR >* attr = static_cast< PRMAttribute< GUM_SCALAR >* >(elt);
        _nameMap_.insert(attr->name(), attr);
 
        while (true) {
          attr->setId(nextNodeId());
          _dag_.addNodeWithId(attr->id());
          _nodeIdMap_.insert(attr->id(), attr);
          _nameMap_.insert(attr->safeName(), attr);
          _attributes_.insert(attr);
 
          if (attr->type().isSubType()) {
            attr = attr->getCastDescendant();
          } else {
            break;
          }
        }
      } else if (PRMClassElement< GUM_SCALAR >::isReferenceSlot(*elt)) {
        elt->setId(nextNodeId());
        _dag_.addNodeWithId(elt->id());
        _nodeIdMap_.insert(elt->id(), elt);
        _referenceSlots_.insert(static_cast< PRMReferenceSlot< GUM_SCALAR >* >(elt));
        _nameMap_.insert(elt->name(), elt);
        _nameMap_.insert(elt->safeName(), elt);
      } else {
        GUM_ERROR(WrongClassElement, "illegal ClassElement<GUM_SCALAR> for an Interface")
      }
 
      return elt->id();
    }

References _attributes_, _dag_, _nameMap_, _nodeIdMap_, _referenceSlots_, gum::prm::PRMAttribute< GUM_SCALAR >::getCastDescendant(), GUM_ERROR, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute(), gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot(), gum::prm::PRMType::isSubType(), gum::prm::PRMObject::name(), gum::prm::nextNodeId(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), gum::prm::PRMClassElement< GUM_SCALAR >::setId(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

Here is the call graph for this function:

◆ addArc()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::addArc	(	std::string_view	tail,
		std::string_view	head )

overridevirtual

An Interfance doesn't have any arc, this will raise an OperationNotAllowed exception.

Parameters

tail	The tail of the added arc.
head	The head of the added arc.

Exceptions

OperationNotAllowed Systematically throws an OperationNotAllowed.

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

Definition at line 352 of file PRMInterface_tpl.h.

                                                                                    {
      GUM_ERROR(OperationNotAllowed, "an Interface does ! have arcs")
    }

References GUM_ERROR.

◆ attributes()

template<GUM_Numeric GUM_SCALAR>

const Set< PRMAttribute< GUM_SCALAR > * > & gum::prm::PRMInterface< GUM_SCALAR >::attributes ( ) const

Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>.

Returns: Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>.

Definition at line 444 of file PRMInterface_tpl.h.

                                                                                           {
      return _attributes_;
    }

References _attributes_.

◆ begin() [1/2]

template<GUM_Numeric GUM_SCALAR>

PRMInterface< GUM_SCALAR >::ClassEltIterator gum::prm::PRMInterface< GUM_SCALAR >::begin ( )

Definition at line 330 of file PRMInterface_tpl.h.

                                                                                          {
      return _nodeIdMap_.begin();
    }

References _nodeIdMap_.

◆ begin() [2/2]

template<GUM_Numeric GUM_SCALAR>

PRMInterface< GUM_SCALAR >::const_ClassEltIterator gum::prm::PRMInterface< GUM_SCALAR >::begin ( ) const

Definition at line 341 of file PRMInterface_tpl.h.

                                                {
      return _nodeIdMap_.begin();
    }

References _nodeIdMap_.

◆ belongsTo()

template<GUM_Numeric GUM_SCALAR>

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

virtualinherited

Returns true if elt belongs to this PRMClassElementContainer.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns: true if elt beglons to this PRMClassElementContainer.

Definition at line 191 of file PRMClassElementContainer_tpl.h.

                                                        {
      try {
        return &elt == &(get(elt.safeName()));
      } catch (NotFound const&) { return false; }
    }

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

Here is the call graph for this function:

◆ containerDag()

template<GUM_Numeric GUM_SCALAR>

const DAG & gum::prm::PRMClassElementContainer< GUM_SCALAR >::containerDag ( ) const

virtualinherited

Returns the gum::DAG of this PRMClassElementContainer.

Be very careful when using NodeId with PRMClassElement<GUM_SCALAR>: there is no guarantee that an inherited PRMClassElement<GUM_SCALAR> will have the same NodeId than its superclass counterpart.

When dealing with different classes and interfaces ALWAYS use safe-name as identifier.

Returns: the DAG of this PRMClassElementContainer.

Definition at line 199 of file PRMClassElementContainer_tpl.h.

                                                                          {
      return dag_();
    }

References dag_().

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addArcs_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), 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::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), exists(), and operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyIOFlags_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMClassElementContainer< GUM_SCALAR >::copyIOFlags_ ( const PRMClassElementContainer< GUM_SCALAR > & c )

protectedvirtualinherited

Copy the IO Flags of c in this PRMClassElementContainer.

Parameters

c	A PRMClassElementContainer.

Definition at line 58 of file PRMClassElementContainer_tpl.h.

                                                         {
      for (const auto& flag: c._IOFlags_)
        setIOFlag_(get(flag.first), flag.second);
    }

References PRMClassElementContainer(), _IOFlags_, get(), and setIOFlag_().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dag_() [1/2]

template<GUM_Numeric GUM_SCALAR>

const DAG & gum::prm::PRMInterface< GUM_SCALAR >::dag_ ( ) const

overrideprotectedvirtual

Returns a constant reference over this PRMInterface's DAG.

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

Definition at line 405 of file PRMInterface_tpl.h.

                                                      {
      return _dag_;
    }

References _dag_.

◆ dag_() [2/2]

template<GUM_Numeric GUM_SCALAR>

DAG & gum::prm::PRMInterface< GUM_SCALAR >::dag_ ( )

overrideprotectedvirtual

Returns a non constant reference over this PRMInterface's DAG.

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

Definition at line 410 of file PRMInterface_tpl.h.

                                          {
      return _dag_;
    }

References _dag_.

◆ end() [1/2]

template<GUM_Numeric GUM_SCALAR>

const PRMInterface< GUM_SCALAR >::ClassEltIterator & gum::prm::PRMInterface< GUM_SCALAR >::end ( )

Definition at line 335 of file PRMInterface_tpl.h.

                                                                                               {
      return _nodeIdMap_.end();
    }

References _nodeIdMap_.

Referenced by _addCastDescendants_().

Here is the caller graph for this function:

◆ end() [2/2]

template<GUM_Numeric GUM_SCALAR>

const PRMInterface< GUM_SCALAR >::const_ClassEltIterator & gum::prm::PRMInterface< GUM_SCALAR >::end ( ) const

Definition at line 347 of file PRMInterface_tpl.h.

                                              {
      return _nodeIdMap_.end();
    }

References _nodeIdMap_.

◆ enum2str()

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:

◆ exists() [1/2]

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists ( NodeId id ) const

virtualinherited

Returns true if a member with the given id exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.

Parameters

id A NodeId.

Returns: true if id matches a PRMClassElement<GUM_SCALAR>.

Definition at line 178 of file PRMClassElementContainer_tpl.h.

                                                                       {
      return containerDag().exists(id);
    }

References containerDag().

Here is the call graph for this function:

◆ exists() [2/2]

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists ( std::string_view name ) const

virtualinherited

Returns true if a member with the given name exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy.

Definition at line 183 of file PRMClassElementContainer_tpl.h.

                                                                                 {
      try {
        get(name);
        return true;
      } catch (NotFound const&) { return false; }
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findAllSubtypes_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::findAllSubtypes_ ( Set< PRMClassElementContainer< GUM_SCALAR > * > & set )

overrideprotectedvirtual

Fills set with all the subtypes of this PRMInterface, this includes extensions and implementations.

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

Definition at line 465 of file PRMInterface_tpl.h.

                                                             {
      for (const auto impl: _implementations_) {
        set.insert(impl);
        impl->findAllSubtypes_(set);
      }
 
      for (const auto ext: _extensions_) {
        set.insert(ext);
        ext->findAllSubtypes_(set);
      }
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), _extensions_, and _implementations_.

Here is the call graph for this function:

◆ get() [1/4]

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

Se gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).

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

Definition at line 422 of file PRMInterface_tpl.h.

                                                                                        {
      auto p = _nodeIdMap_.tryGet(id);
      if (!p) { GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId") }
      return **p;
    }

References _nodeIdMap_, and GUM_ERROR.

◆ get() [2/4]

template<GUM_Numeric GUM_SCALAR>

PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::get ( NodeId id )

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId).

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

Definition at line 415 of file PRMInterface_tpl.h.

                                                                            {
      auto p = _nodeIdMap_.tryGet(id);
      if (!p) { GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId") }
      return **p;
    }

References _nodeIdMap_, and GUM_ERROR.

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), operator[](), operator[](), operator[](), and operator[]().

Here is the caller graph for this function:

◆ get() [3/4]

template<GUM_Numeric GUM_SCALAR>

const PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::get ( std::string_view name ) const

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).

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

Definition at line 437 of file PRMInterface_tpl.h.

                                                                 {
      auto p = _nameMap_.tryGet(name);
      if (!p) { GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name") }
      return **p;
    }

References _nameMap_, GUM_ERROR, and gum::prm::PRMObject::name().

Here is the call graph for this function:

◆ get() [4/4]

template<GUM_Numeric GUM_SCALAR>

PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::get ( std::string_view name )

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).

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

Definition at line 429 of file PRMInterface_tpl.h.

                                                                                      {
      auto p = _nameMap_.tryGet(name);
      if (!p) { GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name") }
      return **p;
    }

References _nameMap_, GUM_ERROR, and gum::prm::PRMObject::name().

Here is the call graph for this function:

◆ getIOFlag_() [1/2]

template<GUM_Numeric GUM_SCALAR>

std::pair< bool, bool > & gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_ ( const PRMClassElement< GUM_SCALAR > & elt )

protectedvirtualinherited

Returns the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.

Returns: elt's IO flags.

Exceptions

NotFound Raised if elt does not have any IO flags.

Definition at line 151 of file PRMClassElementContainer_tpl.h.

                                                  {
      auto p = _IOFlags_.tryGet(elt.safeName());
      if (!p) GUM_ERROR(NotFound, "this ClassElement<GUM_SCALAR> does not have any IO flags")
      return *p;
    }

References _IOFlags_, GUM_ERROR, and gum::prm::PRMClassElement< GUM_SCALAR >::safeName().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_(), gum::prm::PRMClass< GUM_SCALAR >::isOutputNode(), and gum::prm::PRMInterface< GUM_SCALAR >::isOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIOFlag_() [2/2]

template<GUM_Numeric GUM_SCALAR>

const std::pair< bool, bool > & gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_ ( const PRMClassElement< GUM_SCALAR > & elt ) const

protectedvirtualinherited

Returns the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.

Returns: elt's IO flags.

Exceptions

NotFound Raised if elt does not have any IO flags.

Definition at line 159 of file PRMClassElementContainer_tpl.h.

                                                        {
      auto p = _IOFlags_.tryGet(elt.safeName());
      if (!p) GUM_ERROR(NotFound, "this ClassElement<GUM_SCALAR> does not have any IO flags")
      return *p;
    }

References _IOFlags_, GUM_ERROR, and gum::prm::PRMClassElement< GUM_SCALAR >::safeName().

Here is the call graph for this function:

◆ implementations() [1/2]

template<GUM_Numeric GUM_SCALAR>

Set< PRMClass< GUM_SCALAR > * > & gum::prm::PRMInterface< GUM_SCALAR >::implementations ( )

Returns the set of Class<GUM_SCALAR> implementing this PRMInterface.

Definition at line 455 of file PRMInterface_tpl.h.

                                                                                {
      return _implementations_;
    }

References _implementations_.

◆ implementations() [2/2]

template<GUM_Numeric GUM_SCALAR>

const Set< PRMClass< GUM_SCALAR > * > & gum::prm::PRMInterface< GUM_SCALAR >::implementations ( ) const

Returns the set of Class<GUM_SCALAR> implementing this PRMInterface.

Definition at line 460 of file PRMInterface_tpl.h.

                                                                                            {
      return _implementations_;
    }

References _implementations_.

◆ inheritInterface()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::inheritInterface ( )

Inherits from this interface super interface, this should only be done when this inteface inheritance was delayed.

Definition at line 89 of file PRMInterface_tpl.h.

                                                      {
      if (_superInterface_ != nullptr) { _inheritInterface_(*_superInterface_); }
    }

References _inheritInterface_(), and _superInterface_.

Here is the call 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:

◆ isInnerNode()

template<GUM_Numeric GUM_SCALAR>

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

virtualinherited

Returns true if the node is an inner node.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns: true if elt is an inner node.

Exceptions

NotFound	Raised if NodeId does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 137 of file PRMClassElementContainer_tpl.h.

                                                        {
      auto p = _IOFlags_.tryGet(elt.safeName());
      if (!p) return true;
      return !(p->first || p->second);
    }

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

Referenced by gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInputNode()

template<GUM_Numeric GUM_SCALAR>

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

virtualinherited

Returns true if the node is an input node.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Returns: Returns true if id is an input node.

Definition at line 89 of file PRMClassElementContainer_tpl.h.

                                                        {
      auto p = _IOFlags_.tryGet(elt.safeName());
      if (!p) return false;
      return p->first;
    }

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

Here is the call 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;
    }

◆ isOutputNode()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&).

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

Definition at line 479 of file PRMInterface_tpl.h.

                                                                                                {
      try {
        if (!this->getIOFlag_(elt).second) {
          for (auto i: _implementations_) {
            if (i->isOutputNode(elt)) { return true; }
          }
 
          if (_superInterface_ && _superInterface_->isOutputNode(elt)) { return true; }
 
        } else {
          return true;
        }
      } catch (NotFound const&) {}
      return false;
    }

References _implementations_, _superInterface_, and gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_().

Here is the call graph for this function:

◆ isSubTypeOf()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMInterface< GUM_SCALAR >::isSubTypeOf ( const PRMClassElementContainer< GUM_SCALAR > & cec ) const

overridevirtual

Test if this PRMInterface is a sub PRMInterface of cec.

PRMInterface can not be a sub PRMInterface of a Class<GUM_SCALAR>, so if cec is a Class<GUM_SCALAR> this method will return false.

If cec is an PRMInterface then this PRMInterface is a sub PRMInterface of cec if they are equal or there exists a super PRMInterface of this PRMInterface which is equal to cec.

Parameters

cec	The PRMClassElementContainer<GUM_SCALAR> for which we determine if this PRMInterface is a sub PRMInterface of it.

Returns: Returns true if this Class<GUM_SCALAR> is a subclass of cec.

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

Definition at line 290 of file PRMInterface_tpl.h.

                                                                 {
      switch (cec.obj_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_type::CLASS : {
          return false;
        }
 
        case PRMClassElement< GUM_SCALAR >::prm_type::PRM_INTERFACE : {
          const PRMInterface* current = this;
 
          while (current != 0) {
            if (current == &(cec)) return true;
 
            current = current->_superInterface_;
          }
 
          return false;
        }
 
        default : {
          GUM_ERROR(FatalError, "unknown ClassElementContainer<GUM_SCALAR>")
        }
      }
    }

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), PRMInterface(), _superInterface_, gum::prm::PRMObject::CLASS, GUM_ERROR, gum::prm::PRMObject::obj_type(), and gum::prm::PRMObject::PRM_INTERFACE.

Here is the call graph for this function:

◆ isSuperTypeOf()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::isSuperTypeOf ( const PRMClassElementContainer< GUM_SCALAR > & cec ) const

virtualinherited

Test if this PRMClassElementContainer is a super type of cec.

This returns cec.isSubTypeOf(*this).

Parameters

cec

Returns: return true if this PRMClassElementContainer is a super type of cec.

Definition at line 145 of file PRMClassElementContainer_tpl.h.

                                                                 {
      return cec.isSubTypeOf(*this);
    }

References PRMClassElementContainer(), and isSubTypeOf().

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.

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

57{ return _name_; }

gum::prm::PRMObject::_name_

std::string _name_

Definition PRMObject.h:193

References _name_.

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

61{ _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::PRMInterface< GUM_SCALAR >::obj_type ( ) const

overridevirtual

Implementation of pure virtual method of PRMObject.

Implements gum::prm::PRMObject.

Definition at line 400 of file PRMInterface_tpl.h.

                                                                          {
      return PRMObject::prm_type::PRM_INTERFACE;
    }

References gum::prm::PRMObject::PRM_INTERFACE.

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

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

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

Here is the call graph for this function:

◆ operator=()

template<GUM_Numeric GUM_SCALAR>

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

private

Copy operator. Don't use it.

References PRMInterface().

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.

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

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

Here is the call graph for this function:

◆ operator[]() [1/4]

template<GUM_Numeric GUM_SCALAR>

const PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::operator[] ( NodeId id ) const

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).

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

Definition at line 384 of file PRMInterface_tpl.h.

                                                                                               {
      return get(id);
    }

References get().

Here is the call graph for this function:

◆ operator[]() [2/4]

template<GUM_Numeric GUM_SCALAR>

PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::operator[] ( NodeId id )

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId).

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

Definition at line 379 of file PRMInterface_tpl.h.

                                                                                   {
      return get(id);
    }

References get().

Here is the call graph for this function:

◆ operator[]() [3/4]

template<GUM_Numeric GUM_SCALAR>

const PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::operator[] ( std::string_view name ) const

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).

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

Definition at line 395 of file PRMInterface_tpl.h.

                                                                        {
      return get(name);
    }

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

Here is the call graph for this function:

◆ operator[]() [4/4]

template<GUM_Numeric GUM_SCALAR>

PRMClassElement< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::operator[] ( std::string_view name )

overridevirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](const std::string&).

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

Definition at line 389 of file PRMInterface_tpl.h.

                                                                                             {
      return get(name);
    }

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

Here is the call graph for this function:

◆ overload()

template<GUM_Numeric GUM_SCALAR>

NodeId gum::prm::PRMInterface< GUM_SCALAR >::overload ( PRMClassElement< GUM_SCALAR > * elt )

overridevirtual

Add a new PRMClassElement<GUM_SCALAR> which overload an inherited PRMClassElement<GUM_SCALAR>.

The pointer is "given" to this class, which will delete it when ~Class<GUM_SCALAR>() is called.

The NodeId of elt is defined when it is added to this, discarding any previous value. There is no garanty that elt will have the same NodeId than the PRMClassElement<GUM_SCALAR> it overloaded.

You can only overload inherited PRMClassElement<GUM_SCALAR> and only if elt is a subtype of the inherited PRMClassElement<GUM_SCALAR>. You do not define dependencies in an PRMInterface so it is useless to overload an PRMAttribute<GUM_SCALAR> with another sharing the same type, and if tried it will raise an OperationNotAllowed exception.

Parameters

elt	The new PRMClassElement<GUM_SCALAR> overloading an inherited PRMClassElement<GUM_SCALAR> in this.

Returns: the NodeId assigned to elt.

Exceptions

NotFound	Raised if no overloaded PRMClassElement<GUM_SCALAR> is found.
OperationNotAllowed	Raised if the overloading is impossible.

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

Definition at line 167 of file PRMInterface_tpl.h.

                                                                                         {
      if (!_superInterface_)
        GUM_ERROR(OperationNotAllowed, "overload is possible only with sub interfaces")
 
      if (!super().exists(overloader->name()))
        GUM_ERROR(OperationNotAllowed, "found no ClassElement<GUM_SCALAR> to overload")
 
      PRMClassElement< GUM_SCALAR >* overloaded = _nameMap_[overloader->name()];
      if (overloaded == overloader)
        GUM_ERROR(DuplicateElement, "duplicate ClassElement '" << overloader->name() << "'")
 
      if (!_checkOverloadLegality_(overloaded, overloader))
        GUM_ERROR(OperationNotAllowed, "illegal overload")
 
      switch (overloader->elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_attribute : {
          auto attr_overloader = static_cast< PRMAttribute< GUM_SCALAR >* >(overloader);
          auto attr_overloaded = static_cast< PRMAttribute< GUM_SCALAR >* >(overloaded);
          _overloadAttribute_(attr_overloader, attr_overloaded);
          break;
        }
 
        case PRMClassElement< GUM_SCALAR >::prm_refslot : {
          auto ref_overloader = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(overloader);
          auto ref_overloaded = static_cast< PRMReferenceSlot< GUM_SCALAR >* >(overloaded);
          _overloadReferenceSlot_(ref_overloader, ref_overloaded);
          break;
        }
 
        case PRMClassElement< GUM_SCALAR >::prm_aggregate :
        case PRMClassElement< GUM_SCALAR >::prm_slotchain :
          GUM_ERROR(OperationNotAllowed,
                    "Element " << overloader->name() << " can not be overloaded")
        default :
          GUM_ERROR(FatalError, "Unknown ClassElement<GUM_SCALAR> type for " << overloader->name())
      }
 
      return overloader->id();
    }

References _checkOverloadLegality_(), _nameMap_, _overloadAttribute_(), _overloadReferenceSlot_(), _superInterface_, gum::prm::PRMClassElement< GUM_SCALAR >::elt_type(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists(), GUM_ERROR, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::prm_aggregate, gum::prm::PRMClassElement< GUM_SCALAR >::prm_attribute, gum::prm::PRMClassElement< GUM_SCALAR >::prm_refslot, gum::prm::PRMClassElement< GUM_SCALAR >::prm_slotchain, and super().

Here is the call graph for this function:

◆ referenceSlots()

template<GUM_Numeric GUM_SCALAR>

const Set< PRMReferenceSlot< GUM_SCALAR > * > & gum::prm::PRMInterface< GUM_SCALAR >::referenceSlots ( ) const

Returns the set of PRMAggregate of this Class<GUM_SCALAR>.

Returns: Returns the set of PRMAggregate of this Class<GUM_SCALAR>.

Definition at line 450 of file PRMInterface_tpl.h.

                                                         {
      return _referenceSlots_;
    }

References _referenceSlots_.

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

73{ 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:

◆ setInputNode()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode	(	const PRMClassElement< GUM_SCALAR > &	elt,
		bool	b )

virtualinherited

Set the input flag value of id at b.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.
b	The flag value.

Exceptions

NotFound	Raised if id does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 97 of file PRMClassElementContainer_tpl.h.

                                                {
      if (!exists(elt.safeName())) {
        GUM_ERROR(NotFound, ": <" + elt.safeName() + "> is not in <" + name() + ">")
      } else if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)
                 || PRMClassElement< GUM_SCALAR >::isAggregate(elt)) {
        if (auto p = _IOFlags_.tryGet(elt.safeName())) {
          p->first = b;
        } else {
          setIOFlag_(elt, std::make_pair(b, false));
        }
      } else {
        GUM_ERROR(WrongClassElement, "given id is not an PRMAttribute or an PRMAggregate")
      }
    }

References _IOFlags_, exists(), GUM_ERROR, gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate(), gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), and setIOFlag_().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::addArc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIOFlag_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setIOFlag_	(	const PRMClassElement< GUM_SCALAR > &	elt,
		const std::pair< bool, bool > &	flags )

protectedvirtualinherited

Defines the IO flags of a PRMClassElement<GUM_SCALAR>.

Parameters

elt	The PRMClassElement<GUM_SCALAR>.
flags	The IO flags of elt. Overwrite any existing flags.

Returns: elt's IO flags.

Exceptions

NotFound Raised if elt does not have any IO flags.

Definition at line 168 of file PRMClassElementContainer_tpl.h.

                                                                                               {
      if (auto p = _IOFlags_.tryGet(elt.safeName())) {
        *p = flags;
      } else {
        _IOFlags_.insert(elt.safeName(), flags);
      }
    }

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

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_(), copyIOFlags_(), setInputNode(), and setOutputNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOutputNode()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode	(	const PRMClassElement< GUM_SCALAR > &	elt,
		bool	b )

virtualinherited

Set the output flag value of id at b.

PRMAttribute or PRMAggregate can either be input, output, both or internal nodes.

By defaut, attributes and aggregates are inner nodes.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.
b	The flag value.

Exceptions

NotFound	Raised if id does'nt match any PRMClassElement<GUM_SCALAR> in this.
WrongClassElement	Raised if NodeId is neither an PRMAttribute nor an PRMAggregate.

Definition at line 115 of file PRMClassElementContainer_tpl.h.

                                                {
      if (!exists(elt.safeName())) {
        GUM_ERROR(NotFound, "<" + elt.safeName() + "> is not in <" + name() + ">")
      } else if (PRMClassElement< GUM_SCALAR >::isAttribute(elt)
                 || PRMClassElement< GUM_SCALAR >::isAggregate(elt)) {
        if (auto p = _IOFlags_.tryGet(elt.safeName())) {
          p->second = b;
        } else {
          setIOFlag_(elt, std::make_pair(false, b));
        }
 
        if (b) { updateDescendants_(elt); }
      } else {
        GUM_ERROR(WrongClassElement,
                  "given ClassElement<GUM_SCALAR> is not an "
                  "PRMAttribute or an PRMAggregate");
      }
    }

References _IOFlags_, exists(), GUM_ERROR, gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate(), gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute(), gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), setIOFlag_(), and updateDescendants_().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ super() [1/2]

template<GUM_Numeric GUM_SCALAR>

PRMInterface< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::super ( )

Returns the superInterface of this PRMInterface.

Returns: Returns the super PRMInterface of this PRMInterface.

Exceptions

NotFound Raised if this has no super PRMInterface.

Definition at line 357 of file PRMInterface_tpl.h.

                                                                  {
      if (_superInterface_) return *_superInterface_;
      else GUM_ERROR(NotFound, "this Interface is ! a sub interface")
    }

References PRMInterface(), _superInterface_, and GUM_ERROR.

Referenced by PRMInterface(), and overload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ super() [2/2]

template<GUM_Numeric GUM_SCALAR>

const PRMInterface< GUM_SCALAR > & gum::prm::PRMInterface< GUM_SCALAR >::super ( ) const

Returns the superInterface of this PRMInterface.

Returns: Returns the super PRMInterface of this PRMInterface.

Exceptions

NotFound Raised if this has no super PRMInterface.

Definition at line 363 of file PRMInterface_tpl.h.

                                                                              {
      if (_superInterface_) return *_superInterface_;
      else GUM_ERROR(NotFound, "this Interface is ! a sub interface")
    }

References PRMInterface(), _superInterface_, and GUM_ERROR.

Here is the call graph for this function:

◆ updateDescendants_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInterface< GUM_SCALAR >::updateDescendants_ ( const PRMClassElement< GUM_SCALAR > & elt )

overrideprotectedvirtual

See gum::prm::PRMClassElementContainer<GUM_SCALAR>(const PRMClassElement<GUM_SCALAR>&).

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

Definition at line 316 of file PRMInterface_tpl.h.

                                                                                                {
      // for ( const auto ext :  _extensions_ )
      //  if ( !ext->isOutputNode( elt ) ) ext->setOutputNode( elt, true );
 
      // for ( const auto impl :  _implementations_ ) {
      //  // Because of cyclic dependencies we must use a reinterpret cast.
      //  PRMClassElementContainer<GUM_SCALAR>* c =
      //      reinterpret_cast<PRMClassElementContainer<GUM_SCALAR>*>( impl );
 
      //  if ( ! c->isOutputNode( elt ) ) c->setOutputNode( elt, true );
      //}
    }

◆ PRMClass< GUM_SCALAR >

template<GUM_Numeric GUM_SCALAR>

friend class PRMClass< GUM_SCALAR >

friend

Definition at line 404 of file PRMInterface.h.

References PRMInterface().

Referenced by _addImplementation_().

Member Data Documentation

◆ _attributes_

template<GUM_Numeric GUM_SCALAR>

Set< PRMAttribute< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_attributes_

private

The sequence of PRMAttribute<GUM_SCALAR>s.

Definition at line 355 of file PRMInterface.h.

Referenced by _addCastDescendants_(), _inheritInterface_(), _overloadAttribute_(), add(), and attributes().

◆ _dag_

template<GUM_Numeric GUM_SCALAR>

DAG gum::prm::PRMInterface< GUM_SCALAR >::_dag_

private

The dag representing dependencies between formal attributes and slots.

Definition at line 338 of file PRMInterface.h.

Referenced by PRMInterface(), _addCastDescendants_(), _inheritInterface_(), _overloadAttribute_(), add(), dag_(), and dag_().

◆ _extensions_

template<GUM_Numeric GUM_SCALAR>

Set< PRMInterface< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_extensions_

private

The set of Class<GUM_SCALAR> which implements this PRMInterface.

Definition at line 381 of file PRMInterface.h.

Referenced by _addExtension_(), and findAllSubtypes_().

◆ _implementations_

template<GUM_Numeric GUM_SCALAR>

Set< PRMClass< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_implementations_

private

The set of Class<GUM_SCALAR> which implements this PRMInterface.

Definition at line 373 of file PRMInterface.h.

Referenced by _addImplementation_(), findAllSubtypes_(), implementations(), implementations(), and isOutputNode().

◆ _IOFlags_

template<GUM_Numeric GUM_SCALAR>

HashTable< std::string, std::pair< bool, bool > > gum::prm::PRMClassElementContainer< GUM_SCALAR >::_IOFlags_

privateinherited

input / output flags, useful when inheriting or copying.

Definition at line 451 of file PRMClassElementContainer.h.

Referenced by copyIOFlags_(), getIOFlag_(), getIOFlag_(), isInnerNode(), isInputNode(), setInputNode(), setIOFlag_(), and setOutputNode().

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

◆ _nameMap_

template<GUM_Numeric GUM_SCALAR>

HashTable< std::string, PRMClassElement< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_nameMap_

private

Mapping between a member's name and itself. Used for fast access to a member given it's name.

Definition at line 352 of file PRMInterface.h.

Referenced by _addCastDescendants_(), _inheritInterface_(), _overloadAttribute_(), _overloadReferenceSlot_(), add(), get(), get(), and overload().

◆ _nodeIdMap_

template<GUM_Numeric GUM_SCALAR>

NodeProperty< PRMClassElement< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_nodeIdMap_

private

Mapping between node's id and their name (being an attribute or a slot). Used for fast access to a member given it's node id.

Definition at line 342 of file PRMInterface.h.

Referenced by ~PRMInterface(), _addCastDescendants_(), _inheritInterface_(), _overloadAttribute_(), _overloadReferenceSlot_(), add(), begin(), begin(), end(), end(), get(), and get().

◆ _referenceSlots_

template<GUM_Numeric GUM_SCALAR>

Set< PRMReferenceSlot< GUM_SCALAR >* > gum::prm::PRMInterface< GUM_SCALAR >::_referenceSlots_

private

The sequence of PRMReferenceSlot<GUM_SCALAR>.

Definition at line 358 of file PRMInterface.h.

Referenced by _inheritInterface_(), _overloadReferenceSlot_(), add(), and referenceSlots().

◆ _superInterface_

template<GUM_Numeric GUM_SCALAR>

PRMInterface< GUM_SCALAR >* gum::prm::PRMInterface< GUM_SCALAR >::_superInterface_

private

The alternate PRMClassElementContainer<GUM_SCALAR> searched for elements defined in this. Note that this is first searched for gum::PRMClassElement<GUM_SCALAR>.

Definition at line 370 of file PRMInterface.h.

Referenced by PRMInterface(), PRMInterface(), PRMInterface(), inheritInterface(), isOutputNode(), isSubTypeOf(), overload(), super(), and super().

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

agrum/PRM/elements/PRMClass.h
agrum/PRM/elements/PRMInterface.h
agrum/PRM/elements/PRMInterface_tpl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Iterators

Built-in types.

Inheritance members

Detailed Description

Member Typedef Documentation

◆ ClassEltIterator

◆ const_ClassEltIterator

Member Enumeration Documentation

◆ prm_type

Constructor & Destructor Documentation

◆ PRMInterface() [1/3]

◆ PRMInterface() [2/3]

◆ PRMInterface() [3/3]

◆ ~PRMInterface()

Member Function Documentation

◆ _addCastDescendants_()

◆ _addExtension_()

◆ _addImplementation_()

◆ _checkOverloadLegality_()

◆ _inheritInterface_()

◆ _overloadAttribute_()

◆ _overloadReferenceSlot_()

◆ add()

◆ addArc()

◆ attributes()

◆ begin() [1/2]

◆ begin() [2/2]

◆ belongsTo()

◆ containerDag()

◆ copyIOFlags_()

◆ dag_() [1/2]

◆ dag_() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ enum2str()

◆ exists() [1/2]

◆ exists() [2/2]

◆ findAllSubtypes_()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ getIOFlag_() [1/2]

◆ getIOFlag_() [2/2]

◆ implementations() [1/2]

◆ implementations() [2/2]

◆ inheritInterface()

◆ isClass()

◆ isInnerNode()

◆ isInputNode()

◆ isInstance()

◆ isInterface()

◆ isOutputNode()

◆ isSubTypeOf()

◆ isSuperTypeOf()

◆ LEFT_CAST()

◆ name() [1/2]

◆ name() [2/2]

◆ obj_type()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ overload()

◆ referenceSlots()

◆ RIGHT_CAST()

◆ setInputNode()

◆ setIOFlag_()

◆ setOutputNode()

◆ super() [1/2]

◆ super() [2/2]

◆ updateDescendants_()