Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
All Classes Functions Variables Enumerations Enumerator Pages
Public Member Functions | Protected Member Functions | List of all members
mmind::eye::FloatArrayParameter Class Reference

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

#include <Parameter.h>

Inheritance diagram for mmind::eye::FloatArrayParameter:
mmind::eye::Parameter

Public Member Functions

MMIND_API_EXPORT ErrorStatus getValue (std::vector< double > &value) const
 Gets the current value of the device parameter.
 
MMIND_API_EXPORT ErrorStatus setValue (const std::vector< double > &value)
 Sets the value of the device parameter.
 
MMIND_API_EXPORT ErrorStatus getMin (double &min) const
 Gets the minimum settable value of the device parameter.
 
MMIND_API_EXPORT ErrorStatus getMax (double &max) const
 Gets the maximum settable value of the device parameter.
 
MMIND_API_EXPORT ErrorStatus getMaxArraySize (int &maxSize) const
 Gets the maximum settable size of the vector.
 
MMIND_API_EXPORT ErrorStatus getStep (double &step) const
 Gets the adjustment step size of the device parameter.
 
MMIND_API_EXPORT ErrorStatus getUnit (std::string &unit) const
 Gets the unit of the device parameter.
 
- 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
 

Detailed Description

Represents a _FloatArray-type device parameter.

Definition at line 281 of file Parameter.h.


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