Parameter.h

Go to the documentation of this file.

#pragma once
#include <string>
#include <memory>
#include <map>
#include <vector>
#include "api_global.h"
#include "ErrorStatus.h"
#include "CommonTypes.h"
 
namespace Json {
class Value;
}
namespace mmind {
 
class ZmqClientImpl;
 
namespace eye {
 
class MMIND_API_EXPORT Parameter
{
    friend class ParameterFactory;
 
public:
    enum Type {
        _Int,        
        _Float,      
        _Bool,       
        _Enum,       
        _Roi,        
        _Range,      
        _FloatArray, 
        _RoiArray,   
        _ProfileRoi  
    };
 
    virtual ~Parameter();
 
    std::string name() const;
 
    Type type() const;
 
    std::string description() const;
 
    bool isWritable() const;
 
    bool isReadable() const;
 
protected:
    std::shared_ptr<class ParameterImpl> _impl;
    Parameter(const std::string& name, const std::shared_ptr<ZmqClientImpl>& client,
              const std::shared_ptr<Json::Value>& parameterInfo, bool needUpdateMaxAndMin = false,
              bool isVirtual = false);
};
 
class MMIND_API_EXPORT IntParameter : public Parameter
{
public:
    ErrorStatus getValue(int& value) const;
 
    ErrorStatus setValue(int value);
 
    ErrorStatus getMin(int& min) const;
 
    ErrorStatus getMax(int& max) const;
 
    ErrorStatus getStep(int& step) const;
 
    ErrorStatus getUnit(std::string& unit) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT FloatParameter : public Parameter
{
public:
    ErrorStatus getValue(double& value) const;
 
    ErrorStatus setValue(double value);
 
    ErrorStatus getMin(double& min) const;
 
    ErrorStatus getMax(double& max) const;
 
    ErrorStatus getStep(double& step) const;
 
    ErrorStatus getUnit(std::string& unit) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT EnumParameter : public Parameter
{
public:
    ErrorStatus getValue(int& value) const;
 
    ErrorStatus setValue(int value);
 
    ErrorStatus getValue(std::string& valueStr) const;
 
    ErrorStatus setValue(const std::string& value);
 
    ErrorStatus getValues(std::map<std::string, int>& valueList) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT BoolParameter : public Parameter
{
public:
    ErrorStatus getValue(bool& value) const;
 
    ErrorStatus setValue(bool value);
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT RoiParameter : public Parameter
{
public:
    ErrorStatus getValue(ROI& value) const;
 
    ErrorStatus setValue(ROI value);
 
    ErrorStatus getMaxRoiSize(Size& maxSize) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT ProfileRoiParameter : public Parameter
{
public:
    ErrorStatus getValue(ProfileROI& value) const;
 
    ErrorStatus setValue(ProfileROI value);
 
    ErrorStatus getMaxRoiSize(SizeF& maxSize) const;
 
    ErrorStatus getMinRoiSize(SizeF& minSize) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT RoiArrayParameter : public Parameter
{
public:
    ErrorStatus getValue(std::vector<ROI>& value) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT RangeParameter : public Parameter
{
public:
    ErrorStatus getValue(Range<int>& value) const;
 
    ErrorStatus setValue(Range<int> value);
 
    ErrorStatus getMin(int& min) const;
 
    ErrorStatus getMax(int& max) const;
 
    ErrorStatus getStep(int& step) const;
 
    ErrorStatus getUnit(std::string& unit) const;
 
protected:
    using Parameter::Parameter;
};
 
class MMIND_API_EXPORT FloatArrayParameter : public Parameter
{
public:
    ErrorStatus getValue(std::vector<double>& value) const;
 
    ErrorStatus setValue(const std::vector<double>& value);
 
    ErrorStatus getMin(double& min) const;
 
    ErrorStatus getMax(double& max) const;
 
    ErrorStatus getMaxArraySize(int& maxSize) const;
 
    ErrorStatus getStep(double& step) const;
 
    ErrorStatus getUnit(std::string& unit) const;
 
protected:
    using Parameter::Parameter;
};
 
} // namespace eye
} // namespace mmind