mmind::eye::UserSet Class Reference

Represents a device parameter group. More...

#include <UserSet.h>

Public Member Functions
MMIND_API_EXPORT ErrorStatus	getName (std::string &userSetName) const
	Gets the name of the current device parameter group.
MMIND_API_EXPORT ErrorStatus	rename (const std::string &userSetName)
	Renames the current device parameter group.
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	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 std::vector< Parameter * >	getAvailableParameters () const
	Returns the pointer to the element in the vector of all device parameters in the current device parameter group.
MMIND_API_EXPORT Parameter *	getParameter (const std::string &parameterName) const
	Gets the pointer to the elements of a specific device parameter.
MMIND_API_EXPORT Parameter *	operator[] (const std::string &parameterName) const
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	setIntValue (const std::string &parameterName, int value)
	Sets the value of an _Int-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.
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	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	setBoolValue (const std::string &parameterName, bool value)
	Sets the value of a _Bool-type device parameter. See Parameter for details.
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 enumerator. 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. See Parameter for details.
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 details.
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	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	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	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	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 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	setRangeValue (const std::string &parameterName, const Range< int > &value)
	Sets the value of a _Range-type device parameter. See Parameter for details.

Friends
class	UserSetManagerImpl

Detailed Description

Represents a device parameter group.

Definition at line 15 of file UserSet.h.

Friends And Related Symbol Documentation

UserSetManagerImpl

friend class UserSetManagerImpl

friend

Definition at line 149 of file UserSet.h.

---

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

• include/UserSet.h