mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-12 16:21:13 +00:00
a26925cbf5
* move Plugins::Version to fair::mq::tools * fix Parser interface * make device a shared pointer in main * provide std::hash template specialization * fix FairMQ.Plugins/FairMQ.PluginsStatic when run with ctest * fix MQ/serialization example * add --no-as-needed flag * GCC 4 does not support member refs, move to pointer types
108 lines
4.8 KiB
C++
108 lines
4.8 KiB
C++
/********************************************************************************
|
|
* Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
|
|
* *
|
|
* This software is distributed under the terms of the *
|
|
* GNU Lesser General Public Licence (LGPL) version 3, *
|
|
* copied verbatim in the file "LICENSE" *
|
|
********************************************************************************/
|
|
|
|
#ifndef FAIR_MQ_PLUGIN_H
|
|
#define FAIR_MQ_PLUGIN_H
|
|
|
|
#include <fairmq/Tools.h>
|
|
#include <fairmq/PluginServices.h>
|
|
#include <boost/dll/alias.hpp>
|
|
#include <boost/optional.hpp>
|
|
#include <boost/program_options.hpp>
|
|
#include <functional>
|
|
#include <ostream>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <tuple>
|
|
#include <utility>
|
|
|
|
namespace fair
|
|
{
|
|
namespace mq
|
|
{
|
|
|
|
/**
|
|
* @class Plugin Plugin.h <fairmq/Plugin.h>
|
|
* @brief Base class for FairMQ plugins
|
|
*
|
|
* The plugin base class encapsulates the plugin metadata.
|
|
*/
|
|
class Plugin
|
|
{
|
|
public:
|
|
|
|
using ProgOptions = boost::optional<boost::program_options::options_description>;
|
|
|
|
using Version = tools::Version;
|
|
|
|
Plugin() = delete;
|
|
Plugin(const std::string name, const Version version, const std::string maintainer, const std::string homepage, PluginServices* pluginServices);
|
|
virtual ~Plugin();
|
|
|
|
auto GetName() const -> const std::string& { return fkName; }
|
|
auto GetVersion() const -> const Version { return fkVersion; }
|
|
auto GetMaintainer() const -> const std::string& { return fkMaintainer; }
|
|
auto GetHomepage() const -> const std::string& { return fkHomepage; }
|
|
|
|
friend auto operator==(const Plugin& lhs, const Plugin& rhs) -> bool { return std::make_tuple(lhs.GetName(), lhs.GetVersion()) == std::make_tuple(rhs.GetName(), rhs.GetVersion()); }
|
|
friend auto operator!=(const Plugin& lhs, const Plugin& rhs) -> bool { return !(lhs == rhs); }
|
|
friend auto operator<<(std::ostream& os, const Plugin& p) -> std::ostream&
|
|
{
|
|
return os << "'" << p.GetName() << "', "
|
|
<< "version '" << p.GetVersion() << "', "
|
|
<< "maintainer '" << p.GetMaintainer() << "', "
|
|
<< "homepage '" << p.GetHomepage() << "'";
|
|
}
|
|
static auto NoProgramOptions() -> ProgOptions { return boost::none; }
|
|
|
|
// device control API
|
|
// see <fairmq/PluginServices.h> for docs
|
|
using DeviceState = fair::mq::PluginServices::DeviceState;
|
|
using DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition;
|
|
auto ToDeviceState(const std::string& state) const -> DeviceState { return fPluginServices->ToDeviceState(state); }
|
|
auto ToStr(DeviceState state) const -> std::string { return fPluginServices->ToStr(state); }
|
|
auto GetCurrentDeviceState() const -> DeviceState { return fPluginServices->GetCurrentDeviceState(); }
|
|
auto ChangeDeviceState(const DeviceStateTransition next) -> void { fPluginServices->ChangeDeviceState(next); }
|
|
auto SubscribeToDeviceStateChange(std::function<void(DeviceState)> callback) -> void { fPluginServices->SubscribeToDeviceStateChange(fkName, callback); }
|
|
auto UnsubscribeFromDeviceStateChange() -> void { fPluginServices->UnsubscribeFromDeviceStateChange(fkName); }
|
|
|
|
// device config API
|
|
// see <fairmq/PluginServices.h> for docs
|
|
template<typename T>
|
|
auto SetProperty(const std::string& key, T val) -> void { fPluginServices->SetProperty(key, val); }
|
|
template<typename T>
|
|
auto GetProperty(const std::string& key) const -> T { return fPluginServices->GetProperty<T>(key); }
|
|
auto GetPropertyAsString(const std::string& key) const -> std::string { return fPluginServices->GetPropertyAsString(key); }
|
|
// template<typename T>
|
|
// auto SubscribeToPropertyChange(std::function<void(const std::string& [>key*/, const T /*newValue<])> callback) const -> void { fPluginServices.SubscribeToPropertyChange(fkName, callback); }
|
|
// template<typename T>
|
|
// auto UnsubscribeFromPropertyChange() -> void { fPluginServices.UnsubscribeFromPropertyChange<T>(fkName); }
|
|
|
|
private:
|
|
|
|
const std::string fkName;
|
|
const Version fkVersion;
|
|
const std::string fkMaintainer;
|
|
const std::string fkHomepage;
|
|
PluginServices* fPluginServices;
|
|
|
|
}; /* class Plugin */
|
|
|
|
} /* namespace mq */
|
|
} /* namespace fair */
|
|
|
|
#define REGISTER_FAIRMQ_PLUGIN(KLASS, NAME, VERSION, MAINTAINER, HOMEPAGE, PROGOPTIONS) \
|
|
static auto Make_##NAME##_Plugin(fair::mq::PluginServices* pluginServices) -> std::shared_ptr<KLASS> \
|
|
{ \
|
|
return std::make_shared<KLASS>(std::string{#NAME}, VERSION, std::string{MAINTAINER}, std::string{HOMEPAGE}, pluginServices); \
|
|
} \
|
|
BOOST_DLL_ALIAS(Make_##NAME##_Plugin, make_##NAME##_plugin) \
|
|
BOOST_DLL_ALIAS(PROGOPTIONS, get_##NAME##_plugin_progoptions)
|
|
|
|
#endif /* FAIR_MQ_PLUGIN_H */
|