Abstract base class for any element defined in a PRM. More...

#include <PRMObject.h>

Inheritance diagram for gum::prm::PRMObject:

Public Member Functions
Constructor & destructor.
	PRMObject (const std::string &name)
	Constructor. More...

	PRMObject (const PRMObject &source)
	Copy constructor. More...

	PRMObject (PRMObject &&source)
	Move constructor. More...

virtual	~PRMObject ()
	Destructor. 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...

PRMObject &	operator= (const PRMObject &source)
	Copy operator. More...

PRMObject &	operator= (PRMObject &&source)
	Move operator. 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

Abstract base class for any element defined in a PRM.

This class is a base class for any element defined in a PRM. Since objects in a PRM are differentiated by their names, the only information we need about them is their name.

Furthermore we use an enumeration to know the concrete type of a given PRMObject preventing faster type checking.

Definition at line 55 of file PRMObject.h.

Member Enumeration Documentation

◆ prm_type

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

strong

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

◆ PRMObject() [1/3]

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

explicit

Constructor.

Parameters

name	The name of this object.

Definition at line 42 of file PRMObject.cpp.

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

Referenced by isClass(), isInstance(), and isInterface().

42 : _name_(name) { GUM_CONSTRUCTOR(PRMObject); }

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

gum::prm::PRMObject::PRMObject

PRMObject(const std::string &name)

Constructor.

Definition: PRMObject.cpp:42

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PRMObject() [2/3]

gum::prm::PRMObject::PRMObject ( const PRMObject & source )

Copy constructor.

Definition at line 46 of file PRMObject.cpp.

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

                                                 : _name_(source._name_) {
       GUM_CONS_CPY(PRMObject);
     }

Here is the call graph for this function:

◆ PRMObject() [3/3]

gum::prm::PRMObject::PRMObject ( PRMObject && source )

Move constructor.

Definition at line 52 of file PRMObject.cpp.

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

                                            : _name_(std::move(source._name_)) {
       GUM_CONS_CPY(PRMObject);
     }

Here is the call graph for this function:

◆ ~PRMObject()

gum::prm::PRMObject::~PRMObject ( )

virtual

Destructor.

Definition at line 58 of file PRMObject.cpp.

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

                           {
       GUM_DESTRUCTOR(PRMObject);
       ;
     }

Here is the call graph for this function:

Member Function Documentation

◆ enum2str()

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

inlinestatic

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

◆ isClass()

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

inlinestatic

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

References PRMObject().

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

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

Here is the call graph for this function:

◆ isInstance()

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

inlinestatic

Returns true if obj_ptr is of type PRMInstance.

Definition at line 117 of file PRMObject.h.

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

inlinestatic

Returns true if obj_ptr is of type PRMInterface.

Definition at line 112 of file PRMObject.h.

References PRMObject().

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

Here is the call graph for this function:

◆ LEFT_CAST()

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

inlinestatic

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

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 )

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 virtual

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

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=() [1/2]

PRMObject & gum::prm::PRMObject::operator= ( const PRMObject & source )

Copy operator.

Definition at line 64 of file PRMObject.cpp.

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

                                                            {
       _name_ = source._name_;
       return *this;
     }

Here is the call graph for this function:

◆ operator=() [2/2]

PRMObject & gum::prm::PRMObject::operator= ( PRMObject && source )

Move operator.

Definition at line 70 of file PRMObject.cpp.

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

                                                       {
       _name_ = std::move(source._name_);
       return *this;
     }

Here is the call graph for this function:

◆ operator==()

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

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:

◆ RIGHT_CAST()

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

inlinestatic

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

Member Data Documentation

◆ _name_

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

private

Definition at line 205 of file PRMObject.h.

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

agrum/PRM/elements/PRMObject.h
agrum/PRM/elements/PRMObject.cpp
agrum/PRM/elements/PRMObject_inl.h

Public Member Functions

Built-in types.

Detailed Description

Member Enumeration Documentation

◆ prm_type

Constructor & Destructor Documentation

◆ PRMObject() [1/3]

◆ PRMObject() [2/3]

◆ PRMObject() [3/3]

◆ ~PRMObject()

Member Function Documentation

◆ enum2str()

◆ isClass()

◆ isInstance()

◆ isInterface()

◆ LEFT_CAST()

◆ name() [1/2]

◆ name() [2/2]

◆ obj_type()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ RIGHT_CAST()

Member Data Documentation

◆ _name_