Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
VirtualUserSet.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 {
9namespace eye {
10class VirtualUserSetImpl;
11
12class MMIND_API_EXPORT VirtualUserSet
13{
14public:
18 virtual ~VirtualUserSet();
19
26 ErrorStatus getName(std::string& userSetName) const;
27
34 ErrorStatus getAvailableParameterNames(std::vector<std::string>& parameterArrayNames) const;
35
39 std::vector<Parameter*> getAvailableParameters() const;
40
44 Parameter* getParameter(const std::string& parameterName) const;
45
49 Parameter* operator[](const std::string& parameterName) const;
50
59 ErrorStatus getIntValue(const std::string& parameterName, int& value) const;
60
69 ErrorStatus getFloatValue(const std::string& parameterName, double& value) const;
70
79 ErrorStatus getBoolValue(const std::string& parameterName, bool& value) const;
80
89 ErrorStatus getEnumValue(const std::string& parameterName, int& value) const;
90
99 ErrorStatus getEnumValue(const std::string& parameterName, std::string& valueStr) const;
100
109 ErrorStatus getRoiValue(const std::string& parameterName, ROI& value) const;
110
119 ErrorStatus getProfileRoiValue(const std::string& parameterName, ProfileROI& value) const;
120
129 ErrorStatus getFloatArrayValue(const std::string& parameterName,
130 std::vector<double>& value) const;
131
140 ErrorStatus getRangeValue(const std::string& parameterName, Range<int>& value) const;
141
142private:
143 std::shared_ptr<class VirtualUserSetImpl> _impl;
144 explicit VirtualUserSet();
145 friend class VirtualProfilerImpl;
146};
147
148} // namespace eye
149} // namespace mmind
Represents a parameter of the device.
Definition Parameter.h:23
Parameter * getParameter(const std::string &parameterName) const
Gets the pointer to the elements of a specific parameter.
ErrorStatus getAvailableParameterNames(std::vector< std::string > &parameterArrayNames) const
Gets the names of all available parameters of the virtual device.
ErrorStatus getEnumValue(const std::string &parameterName, int &value) const
Gets the current value of an _Enum-type parameter in the form of the integer value....
ErrorStatus getIntValue(const std::string &parameterName, int &value) const
Gets the current value of an _Int-type parameter. See Parameter for details.
ErrorStatus getProfileRoiValue(const std::string &parameterName, ProfileROI &value) const
Gets the current value of an _ProfileRoi-type parameter. See Parameter for details.
ErrorStatus getFloatValue(const std::string &parameterName, double &value) const
Gets the current value of a _Float-type parameter. See Parameter for details.
ErrorStatus getName(std::string &userSetName) const
Gets the name of the parameter group used when the virtual device was saved.
std::vector< Parameter * > getAvailableParameters() const
Returns the pointer to the elements in the vector storing all available parameters.
virtual ~VirtualUserSet()
Destructor.
ErrorStatus getFloatArrayValue(const std::string &parameterName, std::vector< double > &value) const
Gets the current value of a _FloatArray-type parameter. See Parameter for details.
ErrorStatus getEnumValue(const std::string &parameterName, std::string &valueStr) const
Gets the current value of an _Enum-type parameter in the form of a string. See Parameter for details.
ErrorStatus getBoolValue(const std::string &parameterName, bool &value) const
Gets the current value of a _Bool-type parameter. See Parameter for details.
ErrorStatus getRangeValue(const std::string &parameterName, Range< int > &value) const
Gets the current value of a _Range-type parameter. See Parameter for details.
ErrorStatus getRoiValue(const std::string &parameterName, ROI &value) const
Gets the current value of an _Roi-type parameter. See Parameter for details.
Parameter * operator[](const std::string &parameterName) const
Gets the pointer to the elements of a specific parameter.
Describes the types of errors.
Definition ErrorStatus.h:12
Describes the region of interest (ROI) of a laser profiler.
Definition CommonTypes.h:74
Describes a region of interest (ROI).
Definition CommonTypes.h:56
Describes a value range.
Definition CommonTypes.h:18