mmind::eye::UserSetManager Class Reference

Manages device user sets. More...

#include <UserSetManager.h>

Public Member Functions
virtual	~UserSetManager ()
	Destructor.
UserSet &	currentUserSet () const
	Returns a reference to the UserSet object.
ErrorStatus	getAllUserSetNames (std::vector< std::string > &userSets) const
	Gets the names of all available device user sets.
ErrorStatus	selectUserSet (const std::string &userSetName) const
	Selects a device user set to associate with all parameter adjustments.
ErrorStatus	addUserSet (const std::string &userSetName) const
	Adds a device user set to the device.
ErrorStatus	deleteUserSet (const std::string &userSetName) const
	Deletes the selected device user set.
ErrorStatus	saveToFile (const std::string &fileName) const
	Exports all device user sets to a JSON file.
ErrorStatus	loadFromFile (const std::string &fileName)
	Imports device user sets from a JSON file and overwrites existing device user sets on the device.

Friends
class	CameraImpl
class	ProfilerImpl

Detailed Description

Manages device user sets.

Definition at line 14 of file UserSetManager.h.

Member Function Documentation

addUserSet()

ErrorStatus mmind::eye::UserSetManager::addUserSet

(

const std::string &

userSetName

)

const

Adds a device user set to the device.

Parameters

[in]

userSetName

The input user set name to add.

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 Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.

currentUserSet()

UserSet & mmind::eye::UserSetManager::currentUserSet

(

)

const

Returns a reference to the UserSet object.

Returns

See UserSet for details.

deleteUserSet()

ErrorStatus mmind::eye::UserSetManager::deleteUserSet

(

const std::string &

userSetName

)

const

Deletes the selected device user set.

Parameters

[in]

userSetName

The input user set name to delete.

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 does not exist.
ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.

getAllUserSetNames()

ErrorStatus mmind::eye::UserSetManager::getAllUserSetNames

(

std::vector< std::string > &

userSets

)

const

Gets the names of all available device user sets.

Parameters

[out]

userSets

The array of all user set names.

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 Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.

loadFromFile()

ErrorStatus mmind::eye::UserSetManager::loadFromFile

(

const std::string &

fileName

)

Imports device user sets from a JSON file and overwrites existing device user sets on the device.

Parameters

[in]

fileName

The input file 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 Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.
ErrorStatus::MMIND_STATUS_FILE_IO_ERROR Wrong file name passed; or fails to save user set file, or open file, or file format error.

saveToFile()

ErrorStatus mmind::eye::UserSetManager::saveToFile

(

const std::string &

fileName

)

const

Exports all device user sets to a JSON file.

Parameters

[in]

fileName

The input file 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 Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.
ErrorStatus::MMIND_STATUS_FILE_IO_ERROR Fails to save user set file.

selectUserSet()

ErrorStatus mmind::eye::UserSetManager::selectUserSet

(

const std::string &

userSetName

)

const

Selects a device user set to associate with all parameter adjustments.

Parameters

[in]

userSetName

The input user set name to select.

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 Parse response error.
ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR There are errors in reply.

Friends And Related Symbol Documentation

CameraImpl

friend class CameraImpl

friend

Definition at line 119 of file UserSetManager.h.

ProfilerImpl

friend class ProfilerImpl

friend

Definition at line 120 of file UserSetManager.h.

---

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

• include/profiler/UserSetManager.h