Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
mmind::eye::FloatParameter Class Reference

Represents a _Float-type device parameter. More...

#include <Parameter.h>

Inheritance diagram for mmind::eye::FloatParameter:
mmind::eye::Parameter

Public Member Functions

ErrorStatus getValue (double &value) const
 Gets the current value of the device parameter.
 
ErrorStatus setValue (double value)
 Sets the value of the device parameter.
 
ErrorStatus getMin (double &min) const
 Gets the minimum settable value of the device parameter.
 
ErrorStatus getMax (double &max) const
 Gets the maximum settable value of the device parameter.
 
ErrorStatus getStep (double &step) const
 Gets the adjustment step size of the device parameter.
 
ErrorStatus getUnit (std::string &unit) const
 Gets the unit of the device parameter.
 
- Public Member Functions inherited from mmind::eye::Parameter
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 > &parameterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false)
 
- Protected Member Functions inherited from mmind::eye::Parameter
 Parameter (const std::string &name, const std::shared_ptr< ZmqClientImpl > &client, const std::shared_ptr< Json::Value > &parameterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false)
 

Additional Inherited Members

- Public Types inherited from mmind::eye::Parameter
enum  Type {
  _Int , _Float , _Bool , _Enum ,
  _Roi , _Range , _FloatArray , _RoiArray ,
  _ProfileRoi
}
 Describes the device parameter data types. More...
 
- Protected Attributes inherited from mmind::eye::Parameter
std::shared_ptr< class ParameterImpl > _impl
 

Detailed Description

Represents a _Float-type device parameter.

Definition at line 119 of file Parameter.h.


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