DeviceBase.hpp

/*
 * Copyright (C) 2021 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: 2021-10-27
 *     Author: Michal Mysior <mmysior> <michal.mysior@cern.ch>
 *
 */
 
#ifndef DEVICE_BASE_HPP__
#define DEVICE_BASE_HPP__
 
#include <future>
#include <memory>
#include <set>
#include <string>
 
#include <ccut/Signal.hpp>
 
#include "../Units.hpp"
#include "../util/serialize.hpp"
 
namespace smc {
 
enum class DeviceType
{
    AXIS,            
    POSITION_SENSOR, 
    GPIO,            
    TRIGGER,         
    PLATFORM,        
    AXIS_POSITION_MONITOR, 
    UNKNOWN = -1           
};
 
const std::string &to_string(DeviceType type);
 
template<>
DeviceType from_string(const std::string &str);
 
template<>
const std::set<DeviceType> &getEnumValues();
 
typedef std::string DeviceId;
 
class DeviceBase : public std::enable_shared_from_this<DeviceBase>
{
public:
    typedef smc::DeviceType DeviceType;
    typedef std::shared_ptr<DeviceBase> Shared;
 
    virtual ~DeviceBase() = default;
 
    virtual DeviceType type() const = 0;
 
    DeviceId uid() const;
 
    virtual std::future<std::set<std::string>> listConfig() const;
 
    virtual std::future<std::string> getConfig(const std::string &name) const;
 
    virtual std::future<void> setConfig(const std::string &name,
                                        const std::string &value) const;
 
    virtual bool canConvert(const units::Value &value, units::unit_t unit) const;
 
    virtual bool convert(units::Value &value, units::unit_t unit) const;
 
    std::string toString() const;
 
    ccut::Signal<const DeviceBase::Shared &> updateSignal;
 
protected:
    DeviceBase(const std::string &uid);
 
    const std::string m_uid;
};
 
} /* namespace smc */
 
#endif /* DEVICE_BASE_HPP__ */