Device.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: Device
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Model.h>
#include <NDEVR/DesignObjectUpdateTarget.h>
#include <NDEVR/TimeSpan.h>
#include <NDEVR/String.h>
#include <QObject>
#if NDEVR_SUPPORTS_THREADING
#include <QThread>
#endif
namespace NDEVR
{
    class DesignObjectLookup;
    class ProgressInfo;
    class DeviceUpdateThread;
    /**--------------------------------------------------------------------------------------------------
    \brief A root class which describes some physical object, such as a Motor, Sensor, or Connection.
    Devices are updated automatically by calling startAutoUpdate and stopAutoUpdate.
    **/
    class HARDWARE_API Device : public QObject, public Model, public DesignObjectUpdateTarget
    {
        Q_OBJECT
    public:
        Device(const Model& model, ProgressInfo* log, QObject* parent = nullptr);
        virtual void setLog(ProgressInfo* log) { m_log = log; };
        virtual void update(DesignObjectLookup* lookup, Time time) override;
        virtual void update() {};
        [[nodiscard]] virtual TimeSpan updateInterval() const { return TimeSpan(1.0f); }
        virtual void endUpdates() {}
        [[nodiscard]] ProgressInfo* deviceLog() const { return m_log; }
        void setWarningCallback(const std::function<void(const Exception& warning, ProgressInfo* log)>& warning_callback);
        void startAutoUpdate(DesignObjectLookup* lookup = nullptr);
        void stopAutoUpdate(DesignObjectLookup* lookup = nullptr);
        static void SetDefaultDeviceLookup(DesignObjectLookup* lookup);
    signals:
        void onUpdated();
    protected:
        virtual void showWarning(const TranslatedString& warning) const;
        virtual void showWarning(const Exception& warning) const;
    protected:
        ProgressInfo* m_log;
        std::function<void(const Exception& warning, ProgressInfo* log)> m_warning_callback;
        static DesignObjectLookup* s_default_lookup;
#if NDEVR_SUPPORTS_THREADING
        DeviceUpdateThread* m_update_thread = nullptr;
#endif
    };
#if NDEVR_SUPPORTS_THREADING
    /**--------------------------------------------------------------------------------------------------
    \brief A class that updates a device by repeatedly calling update() until stop() is called. 
    
    \warning Should not be called or created directly and instead will be generated by calling Device().startAutoUpdate
        and Device().stopAutoUpdate
    **/
    class HARDWARE_API DeviceUpdateThread : public QThread
    {
    public:
        DeviceUpdateThread(DesignObjectLookup* lookup, Device* sensor);
        DeviceUpdateThread(const DeviceUpdateThread&) = delete;
        DeviceUpdateThread(DeviceUpdateThread&&) = delete;
        virtual ~DeviceUpdateThread() override;
        virtual void run() override;
        void stop();
    protected:
        //std::mutex m_critical_section;//critical section for this object only
        DesignObjectLookup* m_lookup = nullptr;
        Device* m_sensor;
        volatile bool m_is_running;
    };
#endif
}