ParameterDefinition.h

Go to the documentation of this file.

/*
 *  File:       ParameterDefinition.h
 *
 *  Created:    22/09/2016
 *
 *  This file is part of WECore.
 *
 *  WECore is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  WECore is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with WECore.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <unordered_map>
#include <string>
 
namespace ParameterDefinition {
    template <class T>
    T BoundsCheck(T val, T min, T max) {
        if (val < min) val = min;
        if (val > max) val = max;
 
        return val;
    }
 
    class BooleanParameter {
    public:
        BooleanParameter(bool newDefaultValue) :  defaultValue(newDefaultValue) {}
 
        bool defaultValue;
    };
 
    template <class T>
    class BaseParameter {
    public:
 
        const T minValue;
        const T maxValue;
        const T defaultValue;
 
        BaseParameter() = delete;
        virtual ~BaseParameter() = default;
 
        BaseParameter(T newMinValue,
                      T newMaxValue,
                      T newDefaultValue) : minValue(newMinValue),
                                           maxValue(newMaxValue),
                                           defaultValue(newDefaultValue) {}
 
        T BoundsCheck(T val) const {
            return ParameterDefinition::BoundsCheck(val, minValue, maxValue);
        }
    };
 
    template <class T>
    class RangedParameter: public BaseParameter<T> {
    public:
 
        // Inherit the constructor
        using BaseParameter<T>::BaseParameter;
 
        T NormalisedToInternal(T val) const {
            return val * (this->maxValue - this->minValue) + this->minValue;
        }
 
        T InternalToNormalised(T val) const {
            return (val - this->minValue) / (this->maxValue - this->minValue);
        }
    };
}