Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
UserSetManager.h
1#pragma once
2#include <memory>
3#include "api_global.h"
4#include "UserSet.h"
5
6namespace mmind {
7class ZmqClientImpl;
8
9namespace eye {
10
14class MMIND_API_EXPORT UserSetManager
15{
16public:
20 virtual ~UserSetManager();
21
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
116private:
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
Manages device user sets.
ErrorStatus selectUserSet(const std::string &userSetName) const
Selects a device user set to be associated with unsaved parameter adjustments.
ErrorStatus getAllUserSetNames(std::vector< std::string > &userSets) const
Gets the names of all available device user sets.
ErrorStatus addUserSet(const std::string &userSetName) const
Adds a user set to the device.
virtual ~UserSetManager()
Destructor.
ErrorStatus deleteUserSet(const std::string &userSetName) const
Deletes the specified device user set.
ErrorStatus loadFromFile(const std::string &fileName)
Imports device user sets from a JSON file and overwrites existing user sets on the device.
ErrorStatus saveToFile(const std::string &fileName) const
Exports all device user sets to a JSON file.
UserSet & currentUserSet() const
Returns a reference to the UserSet object.
Describes the types of errors.
Definition ErrorStatus.h:12