AxisPositionMonitor.hpp

/*
** Copyright (C) 2023 CERN
**
** This software is provided 'as-is', without any express or implied
** warranty.  In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
**    claim that you wrote the original software. If you use this software
**    in a product, an acknowledgment in the product documentation would be
**    appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
**    misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Created on: 2023-06-13T16:13:34
** Author: Sylvain Fargier <sylvain.fargier@cern.ch>
*/
 
#ifndef AXISPOSITIONMONITOR_HPP__
#define AXISPOSITIONMONITOR_HPP__
 
#include <memory>
 
#include "../util/serialize.hpp"
#include "Axis.hpp"
#include "DeviceBase.hpp"
#include "PositionSensor.hpp"
 
namespace smc {
 
class AxisPositionMonitor : public DeviceBase
{
public:
    typedef std::shared_ptr<AxisPositionMonitor> Shared;
 
    AxisPositionMonitor(const std::string &address,
                        const std::shared_ptr<Axis> &axis,
                        const std::shared_ptr<PositionSensor> &position);
 
    enum State
    {
        UNKNOWN,
        ENABLED,
        DISABLED,
        TRIGGERED
    };
 
    DeviceType type() const override;
 
    inline std::shared_ptr<Axis> axisDevice() const { return m_axis.lock(); }
 
    inline std::shared_ptr<PositionSensor> positionSensorDevice() const
    {
        return m_position.lock();
    }
 
    virtual std::future<units::value_t> getDifference(
        units::unit_t unit) const = 0;
 
    virtual std::future<units::value_t> getMaxDifference(
        units::unit_t unit) const = 0;
 
    virtual std::future<State> getState() const = 0;
 
    virtual std::future<void> setEnabled(bool enabled) = 0;
 
    virtual units::value_t lastDifference(units::unit_t unit) const = 0;
 
    virtual State lastState() const = 0;
 
protected:
    std::weak_ptr<Axis> m_axis;
    std::weak_ptr<PositionSensor> m_position;
};
 
const std::string &to_string(AxisPositionMonitor::State state);
 
template<>
AxisPositionMonitor::State from_string(const std::string &);
 
} // namespace smc
 
#endif