Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
|
Public Member Functions | |
virtual | ~UserSet () |
Destructor. | |
ErrorStatus | getName (std::string &userSetName) const |
Gets the name of the current device user set. | |
ErrorStatus | rename (const std::string &newName) |
Renames the current device user set. | |
ErrorStatus | getAvailableParameterNames (std::vector< std::string > ¶meterArrayNames) const |
Gets the names of all available device parameters in the current device user set. | |
ErrorStatus | resetAllParametersToDefaultValues () |
Resets all device parameters in the current device user set to default values. | |
ErrorStatus | saveAllParametersToDevice () const |
Saves the values of all device parameters in the current device user set to the device. | |
std::vector< Parameter * > | getAvailableParameters () const |
Returns the pointers to the elements in the vector storing all available parameters. | |
Parameter * | getParameter (const std::string ¶meterName) const |
Gets the pointer to the specified device parameter. | |
Parameter * | operator[] (const std::string ¶meterName) const |
Gets the pointer to the specified device parameter. | |
ErrorStatus | getIntValue (const std::string ¶meterName, int &value) const |
Gets the current value of an _Int-type device parameter. See Parameter for details. | |
ErrorStatus | setIntValue (const std::string ¶meterName, int value) |
Sets the value of an _Int-type device parameter. See Parameter for details. | |
ErrorStatus | getFloatValue (const std::string ¶meterName, double &value) const |
Gets the current value of a _Float-type device parameter. See Parameter for details. | |
ErrorStatus | setFloatValue (const std::string ¶meterName, double value) |
Sets the value of a _Float-type device parameter. See Parameter for details. | |
ErrorStatus | getBoolValue (const std::string ¶meterName, bool &value) const |
Gets the current value of a _Bool-type device parameter. See Parameter for details. | |
ErrorStatus | setBoolValue (const std::string ¶meterName, bool value) |
Sets the value of a _Bool-type device parameter. See Parameter for details. | |
ErrorStatus | getEnumValue (const std::string ¶meterName, int &value) const |
Gets the current value of an _Enum-type device parameter in the form of the integer value. See Parameter for details. | |
ErrorStatus | setEnumValue (const std::string ¶meterName, int value) |
Sets the value of an _Enum-type device parameter by inputting the integer value. See Parameter for details. | |
ErrorStatus | getEnumValue (const std::string ¶meterName, std::string &valueStr) const |
Gets the current value of an _Enum-type device parameter in the form of a string. See Parameter for details. | |
ErrorStatus | setEnumValue (const std::string ¶meterName, const std::string &value) |
Sets the value of an _Enum-type device parameter by inputting a string. See Parameter for details. | |
ErrorStatus | getRoiValue (const std::string ¶meterName, ROI &value) const |
Gets the current value of an _Roi-type device parameter. See Parameter for details. | |
ErrorStatus | setRoiValue (const std::string ¶meterName, const ROI &value) |
Sets the value of an _Roi-type device parameter. See Parameter for details. | |
ErrorStatus | getProfileRoiValue (const std::string ¶meterName, ProfileROI &value) const |
Gets the current value of an _ProfileRoi-type device parameter. See Parameter for details. | |
ErrorStatus | setProfileRoiValue (const std::string ¶meterName, const ProfileROI &value) |
Sets the value of an _ProfileRoi-type device parameter. See Parameter for details. | |
ErrorStatus | getRoiArrayValue (const std::string ¶meterName, std::vector< ROI > &value) const |
Gets the current value of a _RoiArray-type device parameter. See Parameter for details. | |
ErrorStatus | getFloatArrayValue (const std::string ¶meterName, std::vector< double > &value) const |
Gets the current value of a _FloatArray-type device parameter. See Parameter for details. | |
ErrorStatus | setFloatArrayValue (const std::string ¶meterName, const std::vector< double > &value) |
Sets the value of a _FloatArray-type device parameter. See Parameter for details. | |
ErrorStatus | getRangeValue (const std::string ¶meterName, Range< int > &value) const |
Gets the current value of a _Range-type device parameter. See Parameter for details. | |
ErrorStatus | setRangeValue (const std::string ¶meterName, const Range< int > &value) |
Sets the value of a _Range-type device parameter. See Parameter for details. | |
Friends | |
class | UserSetManagerImpl |
ErrorStatus mmind::eye::UserSet::getAvailableParameterNames | ( | std::vector< std::string > & | parameterArrayNames | ) | const |
Gets the names of all available device parameters in the current device user set.
[out] | parameterArrayNames | An array storing the parameter names. |
ErrorStatus mmind::eye::UserSet::getBoolValue | ( | const std::string & | parameterName, |
bool & | value ) const |
Gets the current value of a _Bool-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::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. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getEnumValue | ( | const std::string & | parameterName, |
std::string & | valueStr ) const |
Gets the current value of an _Enum-type device parameter in the form of a string. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getFloatArrayValue | ( | const std::string & | parameterName, |
std::vector< double > & | value ) const |
Gets the current value of a _FloatArray-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getFloatValue | ( | const std::string & | parameterName, |
double & | value ) const |
Gets the current value of a _Float-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getIntValue | ( | const std::string & | parameterName, |
int & | value ) const |
Gets the current value of an _Int-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getName | ( | std::string & | userSetName | ) | const |
Gets the name of the current device user set.
[out] | userSetName | The current user set name. |
ErrorStatus mmind::eye::UserSet::getProfileRoiValue | ( | const std::string & | parameterName, |
ProfileROI & | value ) const |
Gets the current value of an _ProfileRoi-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getRangeValue | ( | const std::string & | parameterName, |
Range< int > & | value ) const |
Gets the current value of a _Range-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getRoiArrayValue | ( | const std::string & | parameterName, |
std::vector< ROI > & | value ) const |
Gets the current value of a _RoiArray-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::getRoiValue | ( | const std::string & | parameterName, |
ROI & | value ) const |
Gets the current value of an _Roi-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::rename | ( | const std::string & | newName | ) |
Renames the current device user set.
[in] | newName | The new user set name. |
ErrorStatus mmind::eye::UserSet::resetAllParametersToDefaultValues | ( | ) |
Resets all device parameters in the current device user set to default values.
ErrorStatus mmind::eye::UserSet::saveAllParametersToDevice | ( | ) | const |
Saves the values of all device parameters in the current device user set to the device.
ErrorStatus mmind::eye::UserSet::setBoolValue | ( | const std::string & | parameterName, |
bool | value ) |
Sets the value of a _Bool-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::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.
ErrorStatus mmind::eye::UserSet::setEnumValue | ( | const std::string & | parameterName, |
int | value ) |
Sets the value of an _Enum-type device parameter by inputting the integer value. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setFloatArrayValue | ( | const std::string & | parameterName, |
const std::vector< double > & | value ) |
Sets the value of a _FloatArray-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setFloatValue | ( | const std::string & | parameterName, |
double | value ) |
Sets the value of a _Float-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setIntValue | ( | const std::string & | parameterName, |
int | value ) |
Sets the value of an _Int-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setProfileRoiValue | ( | const std::string & | parameterName, |
const ProfileROI & | value ) |
Sets the value of an _ProfileRoi-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setRangeValue | ( | const std::string & | parameterName, |
const Range< int > & | value ) |
Sets the value of a _Range-type device parameter. See Parameter for details.
ErrorStatus mmind::eye::UserSet::setRoiValue | ( | const std::string & | parameterName, |
const ROI & | value ) |
Sets the value of an _Roi-type device parameter. See Parameter for details.