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

Represents a parameter of the device. More...

#include <Parameter.h>

Inheritance diagram for mmind::eye::Parameter:
mmind::eye::BoolParameter mmind::eye::EnumParameter mmind::eye::FloatArrayParameter mmind::eye::FloatParameter mmind::eye::IntParameter mmind::eye::RangeParameter mmind::eye::RoiParameter

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 > &parameterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false)
 

Protected Attributes

std::shared_ptr< class ParameterImpl > _impl
 

Friends

class ParameterFactory
 

Detailed Description

Represents a parameter of the device.

Definition at line 22 of file Parameter.h.

Member Enumeration Documentation

◆ Type

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.

Friends And Related Symbol Documentation

◆ ParameterFactory

friend class ParameterFactory
friend

Definition at line 24 of file Parameter.h.

Member Data Documentation

◆ _impl

std::shared_ptr<class ParameterImpl> mmind::eye::Parameter::_impl
protected

Definition at line 68 of file Parameter.h.


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