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

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

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

Public Member Functions
Constructor & destructor.
	PRMInterface (const std::string &name)
	Default constructor. More...

	PRMInterface (const std::string &name, PRMInterface< GUM_SCALAR > &super, bool delayInheritance=false)
	Constructor for building a subclass of super. More...

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

virtual	~PRMInterface ()
	Destructor. More...

Graphical model getters and setters
virtual PRMObject::prm_type	obj_type () const
	Implementation of pure virtual method of PRMObject. More...

virtual PRMClassElement< GUM_SCALAR > &	get (NodeId id)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId). More...

virtual const PRMClassElement< GUM_SCALAR > &	get (NodeId id) const
	Se gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(NodeId). More...

void	addArc (const std::string &tail, const std::string &head)
	An Interfance doesn't have any arc, this will raise an OperationNotAllowed exception. More...

PRMClassElement<GUM_SCALAR> getters and setters
virtual bool	isOutputNode (const PRMClassElement< GUM_SCALAR > &elt) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::get(const std::string&). More...

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

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

const Set< PRMAttribute< GUM_SCALAR > *> &	attributes () const
	Returns the set of PRMAttribute<GUM_SCALAR> of this Class<GUM_SCALAR>. More...

const Set< PRMReferenceSlot< GUM_SCALAR > *> &	referenceSlots () const
	Returns the set of PRMAggregate of this Class<GUM_SCALAR>. More...

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

NodeId	overload (PRMClassElement< GUM_SCALAR > *elt)
	Add a new PRMClassElement<GUM_SCALAR> which overload an inherited PRMClassElement<GUM_SCALAR>. More...

Inheritance methods
virtual bool	isSubTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const
	Test if this PRMInterface is a sub PRMInterface of cec. More...

PRMInterface< GUM_SCALAR > &	super ()
	Returns the superInterface of this PRMInterface. More...

const PRMInterface< GUM_SCALAR > &	super () const
	Returns the superInterface of this PRMInterface. More...

Set< PRMClass< GUM_SCALAR > *> &	implementations ()
	Returns the set of Class<GUM_SCALAR> implementing this PRMInterface. More...

const Set< PRMClass< GUM_SCALAR > *> &	implementations () const
	Returns the set of Class<GUM_SCALAR> implementing this PRMInterface. More...

void	inheritInterface ()
	Inherits from this interface super interface, this should only be done when this inteface inheritance was delayed. More...

Getters & setters operators
PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId). More...

const PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id) const
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>::operator[](NodeId). More...

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

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

Getters on the gum::PRMClassElement<GUM_SCALAR>.
virtual bool	belongsTo (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if elt belongs to this PRMClassElementContainer. More...

virtual bool	exists (const std::string &name) const
	Returns true if a member with the given name exists in this PRMClassElementContainer or in the PRMClassElementContainer hierarchy. More...

virtual bool	isInputNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an input node. More...

virtual void	setInputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the input flag value of id at b. More...

virtual void	setOutputNode (const PRMClassElement< GUM_SCALAR > &elt, bool b)
	Set the output flag value of id at b. More...

virtual bool	isInnerNode (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns true if the node is an inner node. More...

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

virtual const DAG &	containerDag () const
	Returns the gum::DAG of this PRMClassElementContainer. More...

Inheritance getters and setters
virtual bool	isSuperTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const
	Test if this PRMClassElementContainer is a super type of cec. More...

Getters & setters.
const std::string &	name () const
	Returns the name of this object. More...

void	name (const std::string &name)
	Change the name of the PRM Object. More...

Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

Protected Member Functions
const DAG &	_dag () const
	Returns a constant reference over this PRMInterface's DAG. More...

DAG &	_dag ()
	Returns a non constant reference over this PRMInterface's DAG. More...

void	_findAllSubtypes (Set< PRMClassElementContainer< GUM_SCALAR > * > &set)
	Fills set with all the subtypes of this PRMInterface, this includes extensions and implementations. More...

void	_updateDescendants (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::prm::PRMClassElementContainer<GUM_SCALAR>(const PRMClassElement<GUM_SCALAR>&). More...

virtual std::pair< bool, bool > &	_getIOFlag (const PRMClassElement< GUM_SCALAR > &elt)
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>. More...

virtual const std::pair< bool, bool > &	_getIOFlag (const PRMClassElement< GUM_SCALAR > &elt) const
	Returns the IO flags of a PRMClassElement<GUM_SCALAR>. More...

virtual void	_setIOFlag (const PRMClassElement< GUM_SCALAR > &elt, const std::pair< bool, bool > &flags)
	Defines the IO flags of a PRMClassElement<GUM_SCALAR>. More...

virtual void	_copyIOFlags (const PRMClassElementContainer< GUM_SCALAR > &c)
	Copy the IO Flags of c in this PRMClassElementContainer. More...

Friends
class	PRMClass< GUM_SCALAR >

Iterators
typedef NodeProperty< PRMClassElement< GUM_SCALAR > *>::iterator	ClassEltIterator

typedef NodeProperty< PRMClassElement< GUM_SCALAR > *>::const_iterator	const_ClassEltIterator

ClassEltIterator	begin ()

const ClassEltIterator &	end ()

const_ClassEltIterator	begin () const

const const_ClassEltIterator &	end () const

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

Set< PRMClass< GUM_SCALAR > *>	__implementations
	The set of Class<GUM_SCALAR> which implements this PRMInterface. More...

Set< PRMInterface< GUM_SCALAR > *>	__extensions
	The set of Class<GUM_SCALAR> which implements this PRMInterface. More...

void	__addImplementation (PRMClass< GUM_SCALAR > *c)
	Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface. More...

void	__addExtension (PRMInterface< GUM_SCALAR > *c)
	Add an Class<GUM_SCALAR> to the set of Class<GUM_SCALAR> which implements this PRMInterface. More...

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

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

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

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

Built-in types.
enum	prm_type : char { prm_type::ALL, prm_type::CLASS, prm_type::PRM_INTERFACE, prm_type::CLASS_ELT, prm_type::TYPE, prm_type::SYSTEM, prm_type::INSTANCE }
	Enumeration of the different types of objects handled by a PRM. More...

static std::string	LEFT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...

static std::string	RIGHT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...

static std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject. More...

static INLINE bool	isClass (const PRMObject &obj)
	Returns true if obj_ptr is of type Class. More...

static INLINE bool	isInterface (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInterface. More...

static INLINE bool	isInstance (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInstance. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::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 54 of file PRMClass.h.

Member Typedef Documentation

◆ ClassEltIterator

template<typename GUM_SCALAR>

typedef NodeProperty< PRMClassElement< GUM_SCALAR >* >::iterator gum::prm::PRMInterface< GUM_SCALAR >::ClassEltIterator

Definition at line 285 of file PRMInterface.h.

◆ const_ClassEltIterator

template<typename GUM_SCALAR>

typedef NodeProperty< PRMClassElement< GUM_SCALAR >* >::const_iterator gum::prm::PRMInterface< GUM_SCALAR >::const_ClassEltIterator

Definition at line 291 of file PRMInterface.h.

Member Enumeration Documentation

◆ prm_type

enum gum::prm::PRMObject::prm_type : char

stronginherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 69 of file PRMObject.h.

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

Constructor & Destructor Documentation

◆ PRMInterface() [1/3]

template<typename GUM_SCALAR >

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

explicit

Default constructor.

Parameters

name	The interface name.

Definition at line 37 of file PRMInterface_tpl.h.

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

◆ PRMInterface() [2/3]

template<typename GUM_SCALAR>

gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface	(	const std::string &	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 43 of file PRMInterface_tpl.h.

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

◆ PRMInterface() [3/3]

template<typename GUM_SCALAR>

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

Copy constructor.

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

◆ ~PRMInterface()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 62 of file PRMInterface_tpl.h.

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

Member Function Documentation

◆ __addCastDescendants()

template<typename 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 257 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);
     }

◆ __addExtension()

template<typename GUM_SCALAR>

INLINE 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 397 of file PRMInterface_tpl.h.

                                                                                {
       __extensions.insert(i);
     }

◆ __addImplementation()

template<typename GUM_SCALAR>

INLINE 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 391 of file PRMInterface_tpl.h.

                                                                                 {
       __implementations.insert(c);
     }

◆ __checkOverloadLegality()

template<typename 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 279 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;
     }

◆ __inheritInterface()

template<typename 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 76 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());
       }
     }

◆ __overloadAttribute()

template<typename 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 214 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;
       }
     }

◆ __overloadReferenceSlot()

template<typename 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 241 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;
     }

◆ _copyIOFlags()

template<typename 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 37 of file PRMClassElementContainer_tpl.h.

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

◆ _dag() [1/2]

template<typename GUM_SCALAR >

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

protectedvirtual

Returns a constant reference over this PRMInterface's DAG.

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

Definition at line 432 of file PRMInterface_tpl.h.

                                                              {
       return __dag;
     }

◆ _dag() [2/2]

template<typename GUM_SCALAR >

INLINE DAG & gum::prm::PRMInterface< GUM_SCALAR >::_dag ( )

protectedvirtual

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

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

Definition at line 437 of file PRMInterface_tpl.h.

                                                  {
       return __dag;
     }

◆ _findAllSubtypes()

template<typename GUM_SCALAR>

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

protectedvirtual

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

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

Definition at line 506 of file PRMInterface_tpl.h.

Referenced by gum::prm::PRMInterface< double >::_findAllSubtypes().

                                                             {
       for (const auto impl : __implementations) {
         set.insert(impl);
         impl->_findAllSubtypes(set);
       }
 
       for (const auto ext : __extensions) {
         set.insert(ext);
         ext->_findAllSubtypes(set);
       }
     }

Here is the caller graph for this function:

◆ _getIOFlag() [1/2]

template<typename GUM_SCALAR>

INLINE 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 131 of file PRMClassElementContainer_tpl.h.

                                                     {
       try {
         return __IOFlags[elt.safeName()];
       } catch (NotFound&) {
         GUM_ERROR(NotFound,
                   "this ClassElement<GUM_SCALAR> does not have any IO flags");
       }
     }

◆ _getIOFlag() [2/2]

template<typename GUM_SCALAR>

INLINE 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 143 of file PRMClassElementContainer_tpl.h.

                                                           {
       try {
         return __IOFlags[elt.safeName()];
       } catch (NotFound&) {
         GUM_ERROR(NotFound,
                   "this ClassElement<GUM_SCALAR> does not have any IO flags");
       }
     }

◆ _setIOFlag()

template<typename GUM_SCALAR>

INLINE 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 154 of file PRMClassElementContainer_tpl.h.

                                                  {
       try {
         __IOFlags[elt.safeName()] = flags;
       } catch (NotFound&) { __IOFlags.insert(elt.safeName(), flags); }
     }

◆ _updateDescendants()

template<typename GUM_SCALAR>

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

protectedvirtual

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

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

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

◆ add()

template<typename GUM_SCALAR>

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

virtual

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

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

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

◆ addArc()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInterface< GUM_SCALAR >::addArc	(	const std::string &	tail,
		const std::string &	head
	)

virtual

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 367 of file PRMInterface_tpl.h.

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

◆ attributes()

template<typename GUM_SCALAR >

INLINE 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 483 of file PRMInterface_tpl.h.

                                                               {
       return __attributes;
     }

◆ begin() [1/2]

template<typename GUM_SCALAR >

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

Definition at line 344 of file PRMInterface_tpl.h.

Referenced by gum::prm::PRMInterface< double >::begin().

                                          {
       return __nodeIdMap.begin();
     }

Here is the caller graph for this function:

◆ begin() [2/2]

template<typename GUM_SCALAR >

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

Definition at line 356 of file PRMInterface_tpl.h.

                                                {
       return __nodeIdMap.begin();
     }

◆ belongsTo()

template<typename GUM_SCALAR>

INLINE 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 177 of file PRMClassElementContainer_tpl.h.

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

◆ containerDag()

template<typename GUM_SCALAR >

INLINE 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 186 of file PRMClassElementContainer_tpl.h.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::__addArcs(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::SVED< GUM_SCALAR >::__initLiftedNodes(), gum::prm::SVE< GUM_SCALAR >::__initLiftedNodes(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), operator<<(), and gum::prm::PRMClass< double >::PRMClass().

                                                                             {
       return _dag();
     }

Here is the caller graph for this function:

◆ end() [1/2]

template<typename GUM_SCALAR >

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

Definition at line 350 of file PRMInterface_tpl.h.

Referenced by gum::prm::PRMInterface< double >::end().

                                        {
       return __nodeIdMap.end();
     }

Here is the caller graph for this function:

◆ end() [2/2]

template<typename GUM_SCALAR >

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

Definition at line 362 of file PRMInterface_tpl.h.

                                              {
       return __nodeIdMap.end();
     }

◆ enum2str()

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

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, gum::prm::PRMObject::CLASS_ELT, gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::PRM_INTERFACE, gum::prm::PRMObject::SYSTEM, and gum::prm::PRMObject::TYPE.

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

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

Here is the caller graph for this function:

◆ exists() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists ( const std::string & name ) const

virtualinherited

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

Definition at line 168 of file PRMClassElementContainer_tpl.h.

Referenced by gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkLocalParent(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkParameters(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::__checkSlotChainLink(), gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMFactory< GUM_SCALAR >::continueAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::continueAttribute(), gum::prm::PRMClassElementContainer< double >::exists(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

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

Here is the caller graph for this function:

◆ exists() [2/2]

template<typename GUM_SCALAR >

INLINE 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 163 of file PRMClassElementContainer_tpl.h.

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

◆ get() [1/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 443 of file PRMInterface_tpl.h.

Referenced by gum::prm::PRMClass< double >::__checkInterface(), and gum::prm::PRMClass< double >::__checkRefInterface().

                                                     {
       try {
         return *(__nodeIdMap[id]);
       } catch (NotFound&) {
         GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId");
       }
     }

Here is the caller graph for this function:

◆ get() [2/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 453 of file PRMInterface_tpl.h.

                                                                 {
       try {
         return *(__nodeIdMap[id]);
       } catch (NotFound&) {
         GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given NodeId");
       }
     }

◆ get() [3/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 463 of file PRMInterface_tpl.h.

                                                                 {
       try {
         return *(__nameMap[name]);
       } catch (NotFound&) {
         GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name");
       }
     }

◆ get() [4/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 473 of file PRMInterface_tpl.h.

                                                                             {
       try {
         return *(__nameMap[name]);
       } catch (NotFound&) {
         GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> with the given name");
       }
     }

◆ implementations() [1/2]

template<typename GUM_SCALAR >

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

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

Definition at line 495 of file PRMInterface_tpl.h.

                                                        {
       return __implementations;
     }

◆ implementations() [2/2]

template<typename GUM_SCALAR >

INLINE 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 501 of file PRMInterface_tpl.h.

                                                                    {
       return __implementations;
     }

◆ inheritInterface()

template<typename 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 71 of file PRMInterface_tpl.h.

                                                       {
       if (__superInterface != nullptr) { __inheritInterface(*__superInterface); }
     }

◆ isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 102 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, and gum::prm::PRMObject::obj_type().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInnerNode()

template<typename GUM_SCALAR>

INLINE 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 116 of file PRMClassElementContainer_tpl.h.

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

                                                        {
       try {
         return !(_getIOFlag(elt).first || _getIOFlag(elt).second);
       } catch (NotFound&) { return true; }
     }

Here is the caller graph for this function:

◆ isInputNode()

template<typename GUM_SCALAR>

INLINE 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 72 of file PRMClassElementContainer_tpl.h.

                                                        {
       try {
         return _getIOFlag(elt).first;
       } catch (NotFound&) { return false; }
     }

◆ isInstance()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 112 of file PRMObject.h.

References gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::name(), gum::prm::PRMObject::obj_type(), gum::prm::PRMObject::operator!=(), gum::prm::PRMObject::operator=(), gum::prm::PRMObject::operator==(), gum::prm::PRMObject::PRMObject(), and gum::prm::PRMObject::~PRMObject().

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

Here is the call graph for this function:

◆ isInterface()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 107 of file PRMObject.h.

References gum::prm::PRMObject::obj_type(), and gum::prm::PRMObject::PRM_INTERFACE.

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

Here is the call graph for this function:

◆ isOutputNode()

template<typename GUM_SCALAR>

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

virtual

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

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

Definition at line 520 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&) {}
       return false;
     }

◆ isSubTypeOf()

template<typename GUM_SCALAR>

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

virtual

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

◆ isSuperTypeOf()

template<typename GUM_SCALAR>

INLINE 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 124 of file PRMClassElementContainer_tpl.h.

                                                                 {
       return cec.isSubTypeOf(*this);
     }

◆ LEFT_CAST()

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

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 79 of file PRMObject.h.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

79 { return "("; }

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

References gum::prm::PRMObject::__name.

35 { return __name; }

gum::prm::PRMObject::__name

std::string __name

Definition: PRMObject.h:200

◆ name() [2/2]

INLINE void gum::prm::PRMObject::name ( const std::string & name )

inherited

Change the name of the PRM Object.

Warning: Don't do this unless you know wath you are doing !

Definition at line 39 of file PRMObject_inl.h.

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

39 { __name = name; }

gum::prm::PRMObject::name

const std::string & name() const

Returns the name of this object.

Definition: PRMObject_inl.h:35

gum::prm::PRMObject::__name

std::string __name

Definition: PRMObject.h:200

Here is the call graph for this function:

◆ obj_type()

template<typename GUM_SCALAR >

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

virtual

Implementation of pure virtual method of PRMObject.

Implements gum::prm::PRMObject.

Definition at line 427 of file PRMInterface_tpl.h.

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

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

Referenced by gum::prm::PRMObject::isInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

template<typename GUM_SCALAR>

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

private

Copy operator. Don't use it.

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

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

Referenced by gum::prm::PRMObject::isInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator[]() [1/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 403 of file PRMInterface_tpl.h.

                                                                 {
       return get(id);
     }

◆ operator[]() [2/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 409 of file PRMInterface_tpl.h.

                                                                             {
       return get(id);
     }

◆ operator[]() [3/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 415 of file PRMInterface_tpl.h.

                                                                             {
       return get(name);
     }

◆ operator[]() [4/4]

template<typename GUM_SCALAR >

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

virtual

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

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

Definition at line 421 of file PRMInterface_tpl.h.

                                                                                         {
       return get(name);
     }

◆ overload()

template<typename GUM_SCALAR>

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

virtual

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 158 of file PRMInterface_tpl.h.

                                                   {
       try {
         if (!super().exists(overloader->name())) {
           GUM_ERROR(OperationNotAllowed,
                     "found no ClassElement<GUM_SCALAR> to overload");
         }
       } catch (NotFound&) {
         GUM_ERROR(OperationNotAllowed,
                   "overload is possible only with sub interfaces");
       }
 
       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: {
           auto msg = "element can ! be overloaded";
           GUM_ERROR(OperationNotAllowed, msg);
           break;
         }
 
         default: {
           GUM_ERROR(FatalError, "unknown ClassElement<GUM_SCALAR> type");
         }
       }
 
       return overloader->id();
     }

◆ referenceSlots()

template<typename GUM_SCALAR >

INLINE 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 489 of file PRMInterface_tpl.h.

                                                                   {
       return __referenceSlots;
     }

◆ RIGHT_CAST()

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

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 80 of file PRMObject.h.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

80 { return ")"; }

Here is the caller graph for this function:

◆ setInputNode()

template<typename GUM_SCALAR>

INLINE 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 80 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)) {
         try {
           _getIOFlag(elt).first = b;
         } catch (NotFound&) { _setIOFlag(elt, std::make_pair(b, false)); }
       } else {
         GUM_ERROR(WrongClassElement,
                   "given id is not an PRMAttribute or an PRMAggregate");
       }
     }

◆ setOutputNode()

template<typename GUM_SCALAR>

INLINE 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 97 of file PRMClassElementContainer_tpl.h.

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

                                                          {
       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)) {
         try {
           _getIOFlag(elt).second = b;
         } catch (NotFound&) { _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");
       }
     }

Here is the caller graph for this function:

◆ super() [1/2]

template<typename GUM_SCALAR >

INLINE 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 373 of file PRMInterface_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addIOInterfaceFlags().

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

Here is the caller graph for this function:

◆ super() [2/2]

template<typename GUM_SCALAR >

INLINE 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 382 of file PRMInterface_tpl.h.

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

Friends And Related Function Documentation

◆ PRMClass< GUM_SCALAR >

template<typename GUM_SCALAR>

friend class PRMClass< GUM_SCALAR >

friend

Definition at line 69 of file PRMInterface.h.

Member Data Documentation

◆ __attributes

template<typename GUM_SCALAR>

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

private

The sequence of PRMAttribute<GUM_SCALAR>s.

Definition at line 344 of file PRMInterface.h.

Referenced by gum::prm::PRMInterface< double >::__inheritInterface().

◆ __dag

template<typename GUM_SCALAR>

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

private

The dag representing dependencies between formal attributes and slots.

Definition at line 327 of file PRMInterface.h.

◆ __extensions

template<typename 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 370 of file PRMInterface.h.

◆ __implementations

template<typename 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 362 of file PRMInterface.h.

◆ __nameMap

template<typename 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 341 of file PRMInterface.h.

Referenced by gum::prm::PRMInterface< double >::__inheritInterface().

◆ __nodeIdMap

template<typename 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 331 of file PRMInterface.h.

◆ __referenceSlots

template<typename GUM_SCALAR>

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

private

The sequence of PRMReferenceSlot<GUM_SCALAR>.

Definition at line 347 of file PRMInterface.h.

Referenced by gum::prm::PRMInterface< double >::__inheritInterface().

◆ __superInterface

template<typename 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 359 of file PRMInterface.h.

Referenced by gum::prm::PRMInterface< double >::isSubTypeOf().

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

Friends

Iterators

Inheritance members

Built-in types.

Detailed Description

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

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

◆ _copyIOFlags()

◆ _dag() [1/2]

◆ _dag() [2/2]

◆ _findAllSubtypes()

◆ _getIOFlag() [1/2]

◆ _getIOFlag() [2/2]

◆ _setIOFlag()

◆ _updateDescendants()

◆ add()

◆ addArc()

◆ attributes()

◆ begin() [1/2]

◆ begin() [2/2]

◆ belongsTo()

◆ containerDag()

◆ end() [1/2]

◆ end() [2/2]

◆ enum2str()

◆ exists() [1/2]

◆ exists() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

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

◆ setOutputNode()

◆ super() [1/2]

◆ super() [2/2]

Friends And Related Function Documentation

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