Parameter.h

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