Mech-Eye API
2.6.0
API reference documentation for Mech-Eye Industrial 3D Camera
Toggle main menu visibility
Loading...
Searching...
No Matches
UserSetManager.h
1
#pragma once
2
#include <memory>
3
#include "api_global.h"
4
#include "UserSet.h"
5
6
namespace
mmind {
7
class
ZmqClientImpl;
8
9
namespace
eye {
10
14
class
MMIND_API_EXPORT UserSetManager
15
{
16
public
:
20
virtual
~UserSetManager
();
21
26
UserSet
&
currentUserSet
()
const
;
27
39
ErrorStatus
getAllUserSetNames
(std::vector<std::string>& userSets)
const
;
40
54
ErrorStatus
selectUserSet
(
const
std::string& userSetName)
const
;
55
69
ErrorStatus
addUserSet
(
const
std::string& userSetName)
const
;
70
84
ErrorStatus
deleteUserSet
(
const
std::string& userSetName)
const
;
85
98
ErrorStatus
saveToFile
(
const
std::string& fileName)
const
;
99
114
ErrorStatus
loadFromFile
(
const
std::string& fileName);
115
116
private
:
117
std::shared_ptr<class UserSetManagerImpl> _impl;
118
explicit
UserSetManager(
const
std::shared_ptr<ZmqClientImpl>& client);
119
friend
class
CameraImpl;
120
friend
class
ProfilerImpl;
121
};
122
123
}
// namespace eye
124
}
// namespace mmind
mmind::eye::UserSet
Definition
UserSet.h:13
mmind::eye::UserSetManager::selectUserSet
ErrorStatus selectUserSet(const std::string &userSetName) const
Selects a device user set to be associated with unsaved parameter adjustments.
mmind::eye::UserSetManager::getAllUserSetNames
ErrorStatus getAllUserSetNames(std::vector< std::string > &userSets) const
Gets the names of all available device user sets.
mmind::eye::UserSetManager::addUserSet
ErrorStatus addUserSet(const std::string &userSetName) const
Adds a user set to the device.
mmind::eye::UserSetManager::~UserSetManager
virtual ~UserSetManager()
Destructor.
mmind::eye::UserSetManager::deleteUserSet
ErrorStatus deleteUserSet(const std::string &userSetName) const
Deletes the specified device user set.
mmind::eye::UserSetManager::loadFromFile
ErrorStatus loadFromFile(const std::string &fileName)
Imports device user sets from a JSON file and overwrites existing user sets on the device.
mmind::eye::UserSetManager::saveToFile
ErrorStatus saveToFile(const std::string &fileName) const
Exports all device user sets to a JSON file.
mmind::eye::UserSetManager::currentUserSet
UserSet & currentUserSet() const
Returns a reference to the UserSet object.
mmind::eye::ErrorStatus
Describes the types of errors.
Definition
ErrorStatus.h:12
Generated by
1.17.0