Mech-Eye API 2.3.3
API reference documentation for Mech-Eye 3D Laser Profiler
|
Represents a parameter of the device. More...
#include <Parameter.h>
Public Types | |
enum | Type { _Int , _Float , _Bool , _Enum , _Roi , _Range , _FloatArray } |
Describes the device parameter data types. More... | |
Public Member Functions | |
std::string | name () const |
Returns the name of the device parameter. | |
Type | type () const |
Returns the data type of the device parameter. | |
std::string | description () const |
Returns the description of the device parameter. | |
bool | isWritable () const |
Returns a Boolean value that indicates the write permission of the device parameter. | |
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< ZmqClientImpl > &client, const std::shared_ptr< Json::Value > ¶meterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false) | |
Protected Attributes | |
std::shared_ptr< class ParameterImpl > | _impl |
Friends | |
class | ParameterFactory |
Represents a parameter of the device.
Definition at line 22 of file Parameter.h.
Describes the device parameter data types.
Enumerator | |
---|---|
_Int | Integer type. |
_Float | Double type. |
_Bool | Boolean type. |
_Enum | Enumeration type. |
_Roi | ROI type. See ROI for details. |
_Range | Range type. See Range for details. |
_FloatArray | Vector of double types. |
Definition at line 30 of file Parameter.h.
|
friend |
Definition at line 24 of file Parameter.h.
|
protected |
Definition at line 68 of file Parameter.h.