<agrum/PRM/classElementContainer.h> More...

#include <PRMClassElementContainer.h>

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

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

Public Member Functions
Protected constructors & destructor.
	PRMClassElementContainer (const std::string &name)
	Default constructor. More...

virtual	~PRMClassElementContainer ()
	Destructor. 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 PRMClassElement< GUM_SCALAR > &	get (const std::string &name)=0
	Getter on a member of this PRMClassElementContainer. More...

virtual const PRMClassElement< GUM_SCALAR > &	get (const std::string &name) const =0
	Constant getter on a member of this PRMClassElementContainer. More...

virtual NodeId	add (PRMClassElement< GUM_SCALAR > *elt)=0
	Add a PRMClassElement<GUM_SCALAR> to this PRMClassElementContainer. More...

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

virtual void	addArc (const std::string &tail, const std::string &head)=0
	Add an arc between two PRMClassElement<GUM_SCALAR>. 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 bool	isOutputNode (const PRMClassElement< GUM_SCALAR > &elt) const =0
	Returns true if the node is an output node. 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 const DAG &	containerDag () const
	Returns the gum::DAG of this PRMClassElementContainer. More...

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 PRMClassElement< GUM_SCALAR > &	get (NodeId id)=0
	Getter on a member of this PRMClassElementContainer. More...

virtual const PRMClassElement< GUM_SCALAR > &	get (NodeId id) const =0
	Constant getter on a member of this PRMClassElementContainer. More...

Getters & setters operators
virtual PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id)=0
	Getter on a member of this PRMClassElementContainer. More...

virtual const PRMClassElement< GUM_SCALAR > &	operator[] (NodeId id) const =0
	Constant getter on a member of this PRMClassElementContainer. More...

virtual PRMClassElement< GUM_SCALAR > &	operator[] (const std::string &name)=0
	Getter on a member of this PRMClassElementContainer. More...

virtual const PRMClassElement< GUM_SCALAR > &	operator[] (const std::string &name) const =0
	Constant getter on a member of this PRMClassElementContainer. More...

Inheritance getters and setters
virtual bool	isSubTypeOf (const PRMClassElementContainer< GUM_SCALAR > &cec) const =0
	Test if this PRMClassElementContainer is a subtype of cec. More...

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

virtual prm_type	obj_type () const =0
	Returns the type of this 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
PRMClassElementContainer< GUM_SCALAR > &	operator= (const PRMClassElementContainer< GUM_SCALAR > &source)
	Copy operator. Don't use it. More...

	PRMClassElementContainer (const PRMClassElementContainer< GUM_SCALAR > &source)
	Copy constructor. Don't use it. More...

virtual const DAG &	dag_ () const =0

virtual DAG &	dag_ ()=0
	Returns a non constant reference over this PRMClassElementContainer's DAG. More...

virtual void	findAllSubtypes_ (Set< PRMClassElementContainer< GUM_SCALAR > * > &set)=0
	Fills set with all the subtypes of this PRMInterface, this includes extensions and implementations. 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...

virtual void	updateDescendants_ (const PRMClassElement< GUM_SCALAR > &elt)=0
	When a PRMClassElement<GUM_SCALAR> becomes an Output node we must update any the IO flags of every descendant of this PRMClassElementContainer. Note that after its declaration, input flags can not be changed and output flags can only become true. More...

Friends
class	PRMClassElementContainterIterator

class	PRMClassElementContainterConstIterator

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::PRMClassElementContainer< GUM_SCALAR >

Abstract class for classes containing gum::PRMClassElement<GUM_SCALAR>.

To print a PRMClassElementContainer you can use the following operator: gum::operator<<(std::ostream&, const PRMClassElementContainer&) which print the PRMClassElementContainer in the graphviz-dot format.

Definition at line 66 of file PRMClassElementContainer.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 68 of file PRMObject.h.

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

Constructor & Destructor Documentation

◆ PRMClassElementContainer() [1/2]

template<typename GUM_SCALAR >

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

Default constructor.

Definition at line 44 of file PRMClassElementContainer_tpl.h.

                                                                                              :
         PRMObject(name) {
       GUM_CONSTRUCTOR(PRMClassElementContainer);
     }

◆ ~PRMClassElementContainer()

template<typename GUM_SCALAR >

INLINE gum::prm::PRMClassElementContainer< GUM_SCALAR >::~PRMClassElementContainer ( )

virtual

Destructor.

Definition at line 50 of file PRMClassElementContainer_tpl.h.

                                                                              {
       GUM_DESTRUCTOR(PRMClassElementContainer);
     }

◆ PRMClassElementContainer() [2/2]

template<typename GUM_SCALAR>

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

protected

Copy constructor. Don't use it.

Definition at line 62 of file PRMClassElementContainer_tpl.h.

                                                              :
         PRMObject(source) {
       GUM_CONS_CPY(PRMClassElementContainer);
       GUM_ERROR(FatalError, "illegal call to ClassElementContainer copy constructor")
     }

Member Function Documentation

◆ add()

template<typename GUM_SCALAR>

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

pure virtual

Add a PRMClassElement<GUM_SCALAR> to this PRMClassElementContainer.

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

The NodeId of elt is defined when it is added to this, discarding any previous value.

If you want to overload an inherited PRMClassElement<GUM_SCALAR> call Class::overload().

When adding an PRMAttribute or an PRMAggregate its type safe name is automatically added, the syntax is <type>name. So you can either use its type safe name or its real name. See the ref prm_typ_inh "type inheritance section" for further details.

Parameters

elt	The PRMClassElement<GUM_SCALAR> added to this Class.

Returns: Returns the NodeId assigned to elt.

Exceptions

DuplicateElement Raised if elt's name is already used in this class.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ addArc()

template<typename GUM_SCALAR>

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

pure virtual

Add an arc between two PRMClassElement<GUM_SCALAR>.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ belongsTo()

template<typename GUM_SCALAR>

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

virtual

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

virtual

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

                                                                                  {
       return dag_();
     }

◆ copyIOFlags_()

template<typename GUM_SCALAR>

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

protectedvirtual

Copy the IO Flags of c in this PRMClassElementContainer.

Parameters

c	A PRMClassElementContainer.

Definition at line 36 of file PRMClassElementContainer_tpl.h.

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

◆ dag_() [1/2]

template<typename GUM_SCALAR>

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

protectedpure virtual

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ dag_() [2/2]

template<typename GUM_SCALAR>

virtual DAG& gum::prm::PRMClassElementContainer< GUM_SCALAR >::dag_ ( )

protectedpure virtual

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

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

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

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

◆ exists() [1/2]

template<typename GUM_SCALAR >

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

virtual

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

Definition at line 162 of file PRMClassElementContainer_tpl.h.

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

◆ exists() [2/2]

template<typename GUM_SCALAR >

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

virtual

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

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

◆ findAllSubtypes_()

template<typename GUM_SCALAR>

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

protectedpure virtual

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

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ get() [1/4]

template<typename GUM_SCALAR>

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

pure virtual

Getter on a member of this PRMClassElementContainer.

Parameters

name	The member's name.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ get() [2/4]

template<typename GUM_SCALAR>

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

pure virtual

Constant getter on a member of this PRMClassElementContainer.

Parameters

name	The member's name.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ get() [3/4]

template<typename GUM_SCALAR>

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

pure virtual

Getter on a member of this PRMClassElementContainer.

Parameters

id	The member's id.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ get() [4/4]

template<typename GUM_SCALAR>

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

pure virtual

Constant getter on a member of this PRMClassElementContainer.

Parameters

id	The member's id.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ getIOFlag_() [1/2]

template<typename GUM_SCALAR>

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

protectedvirtual

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

protectedvirtual

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

◆ isClass()

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

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

gum::prm::PRMObject::prm_type::CLASS

Here is the call graph for this function:

◆ isInnerNode()

template<typename GUM_SCALAR>

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

virtual

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

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

◆ isInputNode()

template<typename GUM_SCALAR>

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

virtual

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 70 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 117 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

Here is the call graph for this function:

◆ isInterface()

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

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 112 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

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

Here is the call graph for this function:

◆ isOutputNode()

template<typename GUM_SCALAR>

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

pure virtual

Returns true if the node is an output 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.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ isSubTypeOf()

template<typename GUM_SCALAR>

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

pure virtual

Test if this PRMClassElementContainer is a subtype of cec.

Parameters

cec

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

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ isSuperTypeOf()

template<typename GUM_SCALAR>

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

virtual

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

79 { return "("; }

◆ name() [1/2]

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

inherited

Returns the name of this object.

Definition at line 34 of file PRMObject_inl.h.

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

34 { return _name_; }

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ name() [2/2]

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

inherited

Change the name of the PRM Object.

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

Definition at line 38 of file PRMObject_inl.h.

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

38 { _name_ = name; }

gum::prm::PRMObject::name

const std::string & name() const

Returns the name of this object.

Definition: PRMObject_inl.h:34

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ obj_type()

virtual prm_type gum::prm::PRMObject::obj_type ( ) const

pure virtualinherited

Returns the type of this object.

Implemented in gum::prm::PRMClassElement< GUM_SCALAR >, gum::prm::PRMClassElement< double >, gum::prm::PRMType, gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, gum::prm::PRMInterface< double >, gum::prm::PRMSystem< GUM_SCALAR >, gum::prm::PRMSystem< double >, and gum::prm::PRMInstance< GUM_SCALAR >.

◆ operator!=()

INLINE bool gum::prm::PRMObject::operator!= ( const PRMObject & obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 46 of file PRMObject_inl.h.

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

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

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ operator=()

template<typename GUM_SCALAR>

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

protected

Copy operator. Don't use it.

Definition at line 56 of file PRMClassElementContainer_tpl.h.

                                                                 {
       GUM_ERROR(FatalError, "illegal call to ClassElementContainer copy operator")
     }

◆ operator==()

INLINE bool gum::prm::PRMObject::operator== ( const PRMObject & obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 42 of file PRMObject_inl.h.

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

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

gum::prm::PRMObject::_name_

std::string _name_

Definition: PRMObject.h:205

Here is the call graph for this function:

◆ operator[]() [1/4]

template<typename GUM_SCALAR>

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

pure virtual

Getter on a member of this PRMClassElementContainer.

Parameters

id	The member's id.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ operator[]() [2/4]

template<typename GUM_SCALAR>

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

pure virtual

Constant getter on a member of this PRMClassElementContainer.

Parameters

id	The member's id.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ operator[]() [3/4]

template<typename GUM_SCALAR>

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

pure virtual

Getter on a member of this PRMClassElementContainer.

Parameters

name	The member's name.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ operator[]() [4/4]

template<typename GUM_SCALAR>

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

pure virtual

Constant getter on a member of this PRMClassElementContainer.

Parameters

name	The member's name.

Returns: Returns a constant reference on the member.

Exceptions

NotFound Raised if no attribute matches name.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

◆ overload()

template<typename GUM_SCALAR>

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

pure virtual

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

The pointer is "given" to this class, which will delete it when ~PRMClassElementContainer() is called.

The NodeId of elt is defined when it is added to this, discarding any previous value. There is no guaranty 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>. Thus you can only overload PRMReferenceSlot and PRMAttribute. In the case of PRMAttribute you can overload an inherited PRMAttribute even if they are of the same type: this is useful when you want to redefine the dependencies of an PRMAttribute or its CPF. You can also overload an PRMAttribute with an PRMAggregate, as long as their respective PRMType allow it.

Parameters

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

Returns: the NodeId assigned to elt.

Exceptions

OperationNotAllowed Raised if overloading is illegal.

Implemented in gum::prm::PRMInterface< GUM_SCALAR >, gum::prm::PRMInterface< double >, gum::prm::PRMClass< GUM_SCALAR >, and gum::prm::PRMClass< double >.

◆ RIGHT_CAST()

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

inlinestaticinherited

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

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

Definition at line 80 of file PRMObject.h.

80 { return ")"; }

◆ setInputNode()

template<typename GUM_SCALAR>

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

virtual

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

◆ setIOFlag_()

template<typename GUM_SCALAR>

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

protectedvirtual

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

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

◆ setOutputNode()

template<typename GUM_SCALAR>

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

virtual

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

◆ updateDescendants_()

template<typename GUM_SCALAR>

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

protectedpure virtual

When a PRMClassElement<GUM_SCALAR> becomes an Output node we must update any the IO flags of every descendant of this PRMClassElementContainer. Note that after its declaration, input flags can not be changed and output flags can only become true.

Parameters

elt	A PRMClassElement<GUM_SCALAR>.

Implemented in gum::prm::PRMClass< GUM_SCALAR >, gum::prm::PRMClass< double >, gum::prm::PRMInterface< GUM_SCALAR >, and gum::prm::PRMInterface< double >.

Friends And Related Function Documentation

◆ PRMClassElementContainterConstIterator

template<typename GUM_SCALAR>

friend class PRMClassElementContainterConstIterator

friend

Definition at line 68 of file PRMClassElementContainer.h.

◆ PRMClassElementContainterIterator

template<typename GUM_SCALAR>

friend class PRMClassElementContainterIterator

friend

Definition at line 67 of file PRMClassElementContainer.h.

Member Data Documentation

◆ _IOFlags_

template<typename GUM_SCALAR>

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

private

input / output flags, useful when inheriting or copying.

Definition at line 438 of file PRMClassElementContainer.h.

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

agrum/PRM/elements/PRMClassElementContainer.h
agrum/PRM/elements/PRMClassElementContainer_tpl.h

Public Member Functions

Protected Member Functions

Friends

Built-in types.

Detailed Description

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

Member Enumeration Documentation

◆ prm_type

Constructor & Destructor Documentation

◆ PRMClassElementContainer() [1/2]

◆ ~PRMClassElementContainer()

◆ PRMClassElementContainer() [2/2]

Member Function Documentation

◆ add()

◆ addArc()

◆ belongsTo()

◆ containerDag()

◆ copyIOFlags_()

◆ dag_() [1/2]

◆ dag_() [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]

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

◆ RIGHT_CAST()

◆ setInputNode()

◆ setIOFlag_()

◆ setOutputNode()

◆ updateDescendants_()

Friends And Related Function Documentation

◆ PRMClassElementContainterConstIterator

◆ PRMClassElementContainterIterator

Member Data Documentation

◆ _IOFlags_

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