zeus::ParamType Class Reference
#include <ParamType.hpp>
Public Member Functions | |
| ParamType (const char *_name="", uint16_t _id=0, bool _isNumber=false, bool _isVector=false) | |
| ParamType (const std::string &_name, uint16_t _id, bool _isNumber=false, bool _isVector=false) | |
| const std::string & | getName () const |
| uint16_t | getId () const |
| bool | operator== (const ParamType &_obj) const |
| bool | operator!= (const ParamType &_obj) const |
| bool | operator== (const std::string &_value) const |
| bool | operator!= (const std::string &_value) const |
| bool | operator== (const uint16_t &_value) const |
| bool | operator!= (const uint16_t &_value) const |
| bool | isNumber () const |
| bool | isVector () const |
Protected Attributes | |
| const std::string | m_typeName |
| const uint16_t | m_id |
| const bool | m_isNumber |
| const bool | m_isVector |
Detailed Description
generisation of type of the type of the parameter
Constructor & Destructor Documentation
§ ParamType() [1/2]
| zeus::ParamType::ParamType | ( | const char * | _name = "", |
| uint16_t | _id = 0, |
||
| bool | _isNumber = false, |
||
| bool | _isVector = false |
||
| ) |
contructor onf a generic name parameter
- Parameters
-
[in] _name Name of the parameter [in] _id Generic Id of the parameter [in] _isNumber set true of the type is a number [in] _isVector set true of the type is a vector element
- Returns
§ ParamType() [2/2]
| zeus::ParamType::ParamType | ( | const std::string & | _name, |
| uint16_t | _id, | ||
| bool | _isNumber = false, |
||
| bool | _isVector = false |
||
| ) |
contructor onf a generic name parameter
- Parameters
-
[in] _name Name of the parameter [in] _id Generic Id of the parameter [in] _isNumber set true of the type is a number [in] _isVector set true of the type is a vector element
- Returns
Member Function Documentation
§ getId()
| uint16_t zeus::ParamType::getId | ( | ) | const |
Get generic Id of the type.
- Returns
- unsigned int containing the type
§ getName()
| const std::string& zeus::ParamType::getName | ( | ) | const |
Get name of tha parameter.
- Returns
- string describing the TYPE
§ isNumber()
| bool zeus::ParamType::isNumber | ( | ) | const |
Check if the type is a number.
- Returns
- return true if the type is a number
§ isVector()
| bool zeus::ParamType::isVector | ( | ) | const |
Check if the type is a vector.
- Returns
- return true if the type is a vector
§ operator!=() [1/3]
| bool zeus::ParamType::operator!= | ( | const ParamType & | _obj | ) | const |
Difference comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type
- Returns
- true if the 2 object are different
§ operator!=() [2/3]
| bool zeus::ParamType::operator!= | ( | const std::string & | _value | ) | const |
Difference comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type in string
- Returns
- true if the 2 object are different
§ operator!=() [3/3]
| bool zeus::ParamType::operator!= | ( | const uint16_t & | _value | ) | const |
Difference comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type enum integer
- Returns
- true if the 2 object are different
§ operator==() [1/3]
| bool zeus::ParamType::operator== | ( | const ParamType & | _obj | ) | const |
Egality comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type
- Returns
- true if the 2 object are identical
§ operator==() [2/3]
| bool zeus::ParamType::operator== | ( | const std::string & | _value | ) | const |
Egality comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type in strin
- Returns
- true if the 2 object are identical
§ operator==() [3/3]
| bool zeus::ParamType::operator== | ( | const uint16_t & | _value | ) | const |
Egality comparaison with an other parameter.
- Parameters
-
[in] _obj Other parameter to compare type enum integer
- Returns
- true if the 2 object are identical
Member Data Documentation
§ m_id
|
protected |
simplification ID (if possible)
§ m_isNumber
|
protected |
if the element is a number (convertion possible)
§ m_isVector
|
protected |
if the element is a vector (convertion possible)
§ m_typeName
|
protected |
generic type
The documentation for this class was generated from the following file:
- framework/atria-soft/zeus/zeus/ParamType.hpp
