UserSet.h

Go to the documentation of this file.

#pragma once
#include <memory>
#include <vector>
#include "api_global.h"
#include "ErrorStatus.h"
#include "Parameter.h"
 
namespace mmind {
class ZmqClientImpl;
namespace eye {
 
class MMIND_API_EXPORT UserSet
{
public:
    virtual ~UserSet();
 
    ErrorStatus getName(std::string& userSetName) const;
 
    ErrorStatus rename(const std::string& newName);
 
    ErrorStatus getAvailableParameterNames(std::vector<std::string>& parameterArrayNames) const;
 
    ErrorStatus resetAllParametersToDefaultValues();
 
    ErrorStatus saveAllParametersToDevice() const;
 
    std::vector<Parameter*> getAvailableParameters() const;
 
    Parameter* getParameter(const std::string& parameterName) const;
 
    Parameter* operator[](const std::string& parameterName) const;
 
    ErrorStatus getIntValue(const std::string& parameterName, int& value) const;
 
    ErrorStatus setIntValue(const std::string& parameterName, int value);
 
    ErrorStatus getFloatValue(const std::string& parameterName, double& value) const;
 
    ErrorStatus setFloatValue(const std::string& parameterName, double value);
 
    ErrorStatus getBoolValue(const std::string& parameterName, bool& value) const;
 
    ErrorStatus setBoolValue(const std::string& parameterName, bool value);
 
    ErrorStatus getEnumValue(const std::string& parameterName, int& value) const;
 
    ErrorStatus setEnumValue(const std::string& parameterName, int value);
 
    ErrorStatus getEnumValue(const std::string& parameterName, std::string& valueStr) const;
 
    ErrorStatus setEnumValue(const std::string& parameterName, const std::string& value);
 
    ErrorStatus getRoiValue(const std::string& parameterName, ROI& value) const;
 
    ErrorStatus setRoiValue(const std::string& parameterName, const ROI& value);
 
    ErrorStatus getProfileRoiValue(const std::string& parameterName, ProfileROI& value) const;
 
    ErrorStatus setProfileRoiValue(const std::string& parameterName, const ProfileROI& value);
 
    ErrorStatus getRoiArrayValue(const std::string& parameterName, std::vector<ROI>& value) const;
 
    ErrorStatus getFloatArrayValue(const std::string& parameterName,
                                   std::vector<double>& value) const;
 
    ErrorStatus setFloatArrayValue(const std::string& parameterName,
                                   const std::vector<double>& value);
 
    ErrorStatus getRangeValue(const std::string& parameterName, Range<int>& value) const;
 
    ErrorStatus setRangeValue(const std::string& parameterName, const Range<int>& value);
 
private:
    std::shared_ptr<class SettingImpl> _impl;
    explicit UserSet(const std::shared_ptr<ZmqClientImpl>& impl);
    friend class UserSetManagerImpl;
};
 
} // namespace eye
} // namespace mmind