TemperatureSensor.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Hardware
File: TemperatureSensor
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Device.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A Device responsible for determining the temperature of either the environment or a specific
        component. Temperatures may have warning limits to alert the user at critical points.
    **/
    class HARDWARE_API TemperatureSensor : public Device
    {
    public:
        enum TemperatureState
        {
              e_temperature_unknown
            , e_temperature_invalid
            , e_temperature_good
            , e_temperature_warning
            , e_temperature_critical
        };
    public:
        TemperatureSensor(const Model& name, ProgressInfo* log, QObject* parent = nullptr);
        [[nodiscard]] fltp08 temperature() const { return m_temperature; }
        [[nodiscard]] virtual TemperatureState temperatureState() const;
        [[nodiscard]] virtual TemperatureState temperatureState(fltp08 temp) const;
 
        void setTemperature(fltp08 temperature);
        void setValidRange(const Bounds<1, fltp08>& range) { m_valid_range = range; };
        void setNoCriticalRange(const Bounds<1, fltp08>& range) { m_no_critical_range = range; };
        void setNoWarningRange(const Bounds<1, fltp08>& range) { m_no_warning_range = range; };
        Bounds<1, fltp08> validRange(){ return m_valid_range; };
        Bounds<1, fltp08> noWarningRange(){ return m_no_critical_range; };
        Bounds<1, fltp08> noCriticalRange(){ return m_no_warning_range;};
    protected:
        Bounds<1, fltp08> m_valid_range;
        Bounds<1, fltp08> m_no_critical_range;
        Bounds<1, fltp08> m_no_warning_range;
        fltp08 m_temperature;
    };
}