 |
Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
|
|
Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
|
Represents an _Enum-type device parameter. More...
#include <Parameter.h>
Public Member Functions | |
| MMIND_API_EXPORT ErrorStatus | getValue (int &value) const |
| Gets the current value of the device parameter in the form of the integer value of the enumerator. | |
| MMIND_API_EXPORT ErrorStatus | setValue (int value) |
| Sets the value of the device parameter by inputting the integer value of an enumerator. | |
| MMIND_API_EXPORT ErrorStatus | getValue (std::string &value) const |
| Gets the current value of the device parameter in the form of a string. | |
| MMIND_API_EXPORT ErrorStatus | setValue (const std::string &value) |
| Sets the value of the device parameter by inputting a string. | |
| MMIND_API_EXPORT ErrorStatus | getValues (std::map< std::string, int > &valueList) const |
| Gets the list of available values of the device parameter in the form of a map. | |
 Public Member Functions inherited from mmind::eye::Parameter | |
| MMIND_API_EXPORT std::string | name () const |
| Returns the name of the device parameter. | |
| MMIND_API_EXPORT Type | type () const |
| Returns the data type of the device parameter. | |
| MMIND_API_EXPORT std::string | description () const |
| Returns the description of the device parameter. | |
| MMIND_API_EXPORT bool | isWritable () const |
| Returns a Boolean value that indicates the write permission of the device parameter. | |
| MMIND_API_EXPORT bool | isReadable () const |
| Returns a Boolean value that indicates the read permission of the device parameter. | |
Protected Member Functions | |
| Parameter (const std::string &name, const std::shared_ptr< class ParameterImpl > &impl, bool needUpdateMaxAndMin=false) | |
| Protected Member Functions inherited from mmind::eye::Parameter | |
| Parameter (const std::string &name, const std::shared_ptr< class ParameterImpl > &impl, bool needUpdateMaxAndMin=false) | |
Additional Inherited Members | |
| Public Types inherited from mmind::eye::Parameter | |
| enum | Type { _Int , _Float , _Bool , _Enum , _Roi , _Range , _FloatArray } |
| The device parameter data types. More... | |
| Protected Attributes inherited from mmind::eye::Parameter | |
| std::shared_ptr< class ParameterImpl > | _impl |
| bool | _needUpdateMaxAndMin |
Represents an _Enum-type device parameter.
Definition at line 157 of file Parameter.h.
1.9.7
