DeviceBase.cpp

/*
 * 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-11-23
 *     Author: Michal Mysior <mmysior> <michal.mysior@cern.ch>
 *
 */
 
#include "DeviceBase.hpp"
 
#include <algorithm>
#include <map>
#include <sstream>
 
#include <ccut/async.hpp>
#include <ccut/utils.hpp>
 
#include "util/serialize.hpp"
 
namespace smc {
 
static const std::string s_empty;
static const std::map<DeviceType, std::string> s_deviceTypesToStr{
    {DeviceType::AXIS, "axis"},
    {DeviceType::POSITION_SENSOR, "position-sensor"},
    {DeviceType::GPIO, "gpio"},
    {DeviceType::TRIGGER, "trigger"},
    {DeviceType::PLATFORM, "platform"},
    {DeviceType::AXIS_POSITION_MONITOR, "axis-position-monitor"},
    {DeviceType::UNKNOWN, "unknown"}};
static const std::map<std::string, DeviceType> s_deviceTypesFromStr{
    ccut::flip(s_deviceTypesToStr)};
static const std::set<DeviceType> s_deviceTypesKeys{
    ccut::keys(s_deviceTypesToStr)};
 
const std::string &to_string(DeviceType type)
{
    std::map<DeviceType, std::string>::const_iterator it =
        s_deviceTypesToStr.find(type);
    return (it != s_deviceTypesToStr.end()) ? it->second : s_empty;
}
 
template<>
DeviceType from_string<DeviceType>(const std::string &str)
{
    std::map<std::string, DeviceType>::const_iterator it =
        s_deviceTypesFromStr.find(str);
    return (it != s_deviceTypesFromStr.end()) ? it->second :
                                                DeviceType::UNKNOWN;
}
 
template<>
const std::set<DeviceType> &getEnumValues<DeviceType>()
{
    return s_deviceTypesKeys;
}
 
DeviceBase::DeviceBase(const std::string &uid) : m_uid{uid} {}
 
std::string DeviceBase::uid() const
{
    return m_uid;
}
 
bool DeviceBase::canConvert(const units::Value &value, units::unit_t unit) const
{
    return value.canConvert(unit);
}
 
bool DeviceBase::convert(units::Value &value, units::unit_t unit) const
{
    return value.convert(unit);
}
 
std::future<std::set<std::string>> DeviceBase::listConfig() const
{
    std::promise<std::set<std::string>> prom;
    prom.set_value(std::set<std::string>());
    return prom.get_future();
}
 
std::future<std::string> DeviceBase::getConfig(const std::string &name) const
{
    return ccut::make_future_error<std::string>(Exception(
        ErrorCode::InvalidArguments, "no such config value: " + name));
}
 
std::future<void> DeviceBase::setConfig(const std::string &name,
                                        const std::string &) const
{
    return ccut::make_future_error(Exception(ErrorCode::InvalidArguments,
                                             "no such config value: " + name));
}
 
std::string DeviceBase::toString() const
{
    std::stringstream ss;
    ss << "Device{" << to_string(type()) << ", " << m_uid << "}";
    return ss.str();
}
 
} // namespace smc