Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
All Classes Functions Variables Enumerations Enumerator Pages
UserSet.h
1#pragma once
2#include <memory>
3#include <vector>
4#include "api_global.h"
5#include "ErrorStatus.h"
6#include "Parameter.h"
7
8namespace mmind {
9
10namespace eye {
11
16{
17public:
18 MMIND_API_EXPORT virtual ~UserSet();
19
23 MMIND_API_EXPORT ErrorStatus getName(std::string& userSetName) const;
24
28 MMIND_API_EXPORT ErrorStatus rename(const std::string& userSetName);
29
33 MMIND_API_EXPORT ErrorStatus
34 getAvailableParameterNames(std::vector<std::string>& parameterArrayNames) const;
35
40
44 MMIND_API_EXPORT ErrorStatus saveAllParametersToDevice() const;
45
49 MMIND_API_EXPORT std::vector<Parameter*> getAvailableParameters() const;
50
54 MMIND_API_EXPORT Parameter* getParameter(const std::string& parameterName) const;
55
56 MMIND_API_EXPORT Parameter* operator[](const std::string& parameterName) const;
57
61 MMIND_API_EXPORT ErrorStatus getIntValue(const std::string& parameterName, int& value) const;
62
66 MMIND_API_EXPORT ErrorStatus setIntValue(const std::string& parameterName, int value);
67
71 MMIND_API_EXPORT ErrorStatus getFloatValue(const std::string& parameterName,
72 double& value) const;
73
77 MMIND_API_EXPORT ErrorStatus setFloatValue(const std::string& parameterName, double value);
78
82 MMIND_API_EXPORT ErrorStatus getBoolValue(const std::string& parameterName, bool& value) const;
83
87 MMIND_API_EXPORT ErrorStatus setBoolValue(const std::string& parameterName, bool value);
88
92 MMIND_API_EXPORT ErrorStatus getEnumValue(const std::string& parameterName, int& value) const;
93
97 MMIND_API_EXPORT ErrorStatus setEnumValue(const std::string& parameterName, int value);
98
102 MMIND_API_EXPORT ErrorStatus getEnumValue(const std::string& parameterName,
103 std::string& value) const;
104
108 MMIND_API_EXPORT ErrorStatus setEnumValue(const std::string& parameterName,
109 const std::string& value);
110
114 MMIND_API_EXPORT ErrorStatus getRoiValue(const std::string& parameterName, ROI& value) const;
115
119 MMIND_API_EXPORT ErrorStatus setRoiValue(const std::string& parameterName, const ROI& value);
120
124 MMIND_API_EXPORT ErrorStatus getFloatArrayValue(const std::string& parameterName,
125 std::vector<double>& value) const;
126
130 MMIND_API_EXPORT ErrorStatus setFloatArrayValue(const std::string& parameterName,
131 const std::vector<double>& value);
132
136 MMIND_API_EXPORT ErrorStatus getRangeValue(const std::string& parameterName,
137 Range<int>& value) const;
138
142 MMIND_API_EXPORT ErrorStatus setRangeValue(const std::string& parameterName,
143 const Range<int>& value);
144
145private:
146 std::shared_ptr<class SettingImpl> _impl;
147 UserSet();
148 explicit UserSet(const std::shared_ptr<class SettingImpl>& impl);
149 friend class UserSetManagerImpl;
150};
151
152} // namespace eye
153} // namespace mmind
Represents a parameter of the device.
Definition Parameter.h:18
Represents a device parameter group.
Definition UserSet.h:16
MMIND_API_EXPORT ErrorStatus getName(std::string &userSetName) const
Gets the name of the current device parameter group.
MMIND_API_EXPORT ErrorStatus getIntValue(const std::string &parameterName, int &value) const
Gets the current value of an _Int-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus setRoiValue(const std::string &parameterName, const ROI &value)
Sets the value of an _Roi-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus resetAllParametersToDefaultValues()
Resets all device parameters in the current device parameter group to default values.
MMIND_API_EXPORT ErrorStatus saveAllParametersToDevice() const
Saves the values of all device parameters in the current device parameter group to the device.
MMIND_API_EXPORT ErrorStatus setEnumValue(const std::string &parameterName, const std::string &value)
Sets the value of an _Enum-type device parameter by inputting a string. See Parameter for details.
MMIND_API_EXPORT ErrorStatus setFloatArrayValue(const std::string &parameterName, const std::vector< double > &value)
Sets the value of a _FloatArray-type device parameter. See Parameter for details.
MMIND_API_EXPORT Parameter * getParameter(const std::string &parameterName) const
Gets the pointer to the elements of a specific device parameter.
MMIND_API_EXPORT ErrorStatus getRoiValue(const std::string &parameterName, ROI &value) const
Gets the current value of an _Roi-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus setEnumValue(const std::string &parameterName, int value)
Sets the value of an _Enum-type device parameter by inputting the integer value of an enumerator....
MMIND_API_EXPORT ErrorStatus setIntValue(const std::string &parameterName, int value)
Sets the value of an _Int-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus getRangeValue(const std::string &parameterName, Range< int > &value) const
Gets the current value of a _Range-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus getFloatArrayValue(const std::string &parameterName, std::vector< double > &value) const
Gets the current value of a _FloatArray-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus getAvailableParameterNames(std::vector< std::string > &parameterArrayNames) const
Gets the names of all device parameters in the current device parameter group.
MMIND_API_EXPORT ErrorStatus getEnumValue(const std::string &parameterName, int &value) const
Gets the current value of an _Enum-type device parameter in the form of the integer value of the enum...
MMIND_API_EXPORT ErrorStatus getEnumValue(const std::string &parameterName, std::string &value) const
Gets the current value of an _Enum-type device parameter in the form of a string. See Parameter for d...
MMIND_API_EXPORT std::vector< Parameter * > getAvailableParameters() const
Returns the pointer to the element in the vector of all device parameters in the current device param...
MMIND_API_EXPORT ErrorStatus getBoolValue(const std::string &parameterName, bool &value) const
Gets the current value of a _Bool-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus setFloatValue(const std::string &parameterName, double value)
Sets the value of a _Float-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus setRangeValue(const std::string &parameterName, const Range< int > &value)
Sets the value of a _Range-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus rename(const std::string &userSetName)
Renames the current device parameter group.
MMIND_API_EXPORT ErrorStatus setBoolValue(const std::string &parameterName, bool value)
Sets the value of a _Bool-type device parameter. See Parameter for details.
MMIND_API_EXPORT ErrorStatus getFloatValue(const std::string &parameterName, double &value) const
Gets the current value of a _Float-type device parameter. See Parameter for details.
The types of errors.
Definition ErrorStatus.h:11
A region of interest.
Definition CommonTypes.h:35
A value range.
Definition CommonTypes.h:11