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 > &parameterArrayNames) 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 &parameterName) const
	Gets the pointer to the specified device parameter.

Parameter *	operator[] (const std::string &parameterName) const
	Gets the pointer to the specified device parameter.

ErrorStatus	getIntValue (const std::string &parameterName, int &value) const
	Gets the current value of an _Int-type device parameter. See Parameter for details.

ErrorStatus	setIntValue (const std::string &parameterName, int value)
	Sets the value of an _Int-type device parameter. See Parameter for details.

ErrorStatus	getFloatValue (const std::string &parameterName, double &value) const
	Gets the current value of a _Float-type device parameter. See Parameter for details.

ErrorStatus	setFloatValue (const std::string &parameterName, double value)
	Sets the value of a _Float-type device parameter. See Parameter for details.

ErrorStatus	getBoolValue (const std::string &parameterName, bool &value) const
	Gets the current value of a _Bool-type device parameter. See Parameter for details.

ErrorStatus	setBoolValue (const std::string &parameterName, bool value)
	Sets the value of a _Bool-type device parameter. See Parameter for details.

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. See Parameter for details.

ErrorStatus	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	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	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	getRoiValue (const std::string &parameterName, ROI &value) const
	Gets the current value of an _Roi-type device parameter. See Parameter for details.

ErrorStatus	setRoiValue (const std::string &parameterName, const ROI &value)
	Sets the value of an _Roi-type device parameter. See Parameter for details.

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.

ErrorStatus	setFloatArrayValue (const std::string &parameterName, const std::vector< double > &value)
	Sets the value of a _FloatArray-type device parameter. See Parameter for details.

ErrorStatus	getRangeValue (const std::string &parameterName, Range< int > &value) const
	Gets the current value of a _Range-type device parameter. See Parameter for details.

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

Definition at line 12 of file UserSet.h.

Member Function Documentation

◆ getAvailableParameterNames()

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.

Parameters

[out] parameterArrayNames An array storing the parameter names.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.

◆ getBoolValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getEnumValue() [1/2]

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getEnumValue() [2/2]

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getFloatArrayValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getFloatValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getIntValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getName()

ErrorStatus mmind::eye::UserSet::getName ( std::string & userSetName ) const

Gets the name of the current device user set.

Parameters

[out] userSetName The current user set name.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.

◆ getRangeValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getRoiValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ rename()

ErrorStatus mmind::eye::UserSet::rename ( const std::string & newName )

Renames the current device user set.

Parameters

[in] newName The new user set name.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_INVALID_INPUT_ERROR The user set name entered is empty or too long.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.

◆ resetAllParametersToDefaultValues()

ErrorStatus mmind::eye::UserSet::resetAllParametersToDefaultValues ( )

Resets all device parameters in the current device user set to default values.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.

◆ saveAllParametersToDevice()

ErrorStatus mmind::eye::UserSet::saveAllParametersToDevice ( ) const

Saves the values of all device parameters in the current device user set to the device.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.

◆ setBoolValue()

ErrorStatus mmind::eye::UserSet::setBoolValue	(	const std::string &	parameterName,
		bool	value )

Sets the value of a _Bool-type device parameter. See Parameter for details.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.

◆ setEnumValue() [1/2]

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid enum input.

◆ setEnumValue() [2/2]

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid enum input.

◆ setFloatArrayValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid parameter input.

◆ setFloatValue()

ErrorStatus mmind::eye::UserSet::setFloatValue	(	const std::string &	parameterName,
		double	value )

Sets the value of a _Float-type device parameter. See Parameter for details.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid parameter input.

◆ setIntValue()

ErrorStatus mmind::eye::UserSet::setIntValue	(	const std::string &	parameterName,
		int	value )

Sets the value of an _Int-type device parameter. See Parameter for details.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid parameter input.

◆ setRangeValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid parameter input.

◆ setRoiValue()

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.

Returns: ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid device handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Device disconnected.
ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR Timeout error.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Response parsing error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR The reply from the device contains errors.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found or read only, please check the input parameter name.
ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR Invalid parameter input.

Friends And Related Symbol Documentation

◆ UserSetManagerImpl

friend class UserSetManagerImpl

friend

Definition at line 343 of file UserSet.h.

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

include/camera/UserSet.h

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ getAvailableParameterNames()

◆ getBoolValue()

◆ getEnumValue() [1/2]

◆ getEnumValue() [2/2]

◆ getFloatArrayValue()

◆ getFloatValue()

◆ getIntValue()

◆ getName()

◆ getRangeValue()

◆ getRoiValue()

◆ rename()

◆ resetAllParametersToDefaultValues()

◆ saveAllParametersToDevice()

◆ setBoolValue()

◆ setEnumValue() [1/2]

◆ setEnumValue() [2/2]

◆ setFloatArrayValue()

◆ setFloatValue()

◆ setIntValue()

◆ setRangeValue()

◆ setRoiValue()

Friends And Related Symbol Documentation

◆ UserSetManagerImpl