Mech-Eye API 2.3.3
API reference documentation for Mech-Eye Industrial 3D Camera
|
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 be associated with unsaved parameter adjustments. | |
ErrorStatus | addUserSet (const std::string &userSetName) const |
Adds a user set to the device. | |
ErrorStatus | deleteUserSet (const std::string &userSetName) const |
Deletes the specified 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 user sets on the device. | |
Friends | |
class | CameraImpl |
class | ProfilerImpl |
Manages device user sets.
Definition at line 14 of file UserSetManager.h.
ErrorStatus mmind::eye::UserSetManager::addUserSet | ( | const std::string & | userSetName | ) | const |
Adds a user set to the device.
[in] | userSetName | The name of the user set to be added. |
UserSet & mmind::eye::UserSetManager::currentUserSet | ( | ) | const |
ErrorStatus mmind::eye::UserSetManager::deleteUserSet | ( | const std::string & | userSetName | ) | const |
Deletes the specified device user set.
[in] | userSetName | The name of the user set to be deleted. |
ErrorStatus mmind::eye::UserSetManager::getAllUserSetNames | ( | std::vector< std::string > & | userSets | ) | const |
Gets the names of all available device user sets.
[out] | userSets | The array of all user set names. |
ErrorStatus mmind::eye::UserSetManager::loadFromFile | ( | const std::string & | fileName | ) |
Imports device user sets from a JSON file and overwrites existing user sets on the device.
[in] | fileName | The name of the JSON file. |
ErrorStatus mmind::eye::UserSetManager::saveToFile | ( | const std::string & | fileName | ) | const |
Exports all device user sets to a JSON file.
[in] | fileName | The name of the JSON file. |
ErrorStatus mmind::eye::UserSetManager::selectUserSet | ( | const std::string & | userSetName | ) | const |
Selects a device user set to be associated with unsaved parameter adjustments.
[in] | userSetName | The name of the user set to be selected. |
Definition at line 119 of file UserSetManager.h.
Definition at line 120 of file UserSetManager.h.