using ProgOptions = boost::optional<boost::program_options::options_description>No comment in the header yet.
API · fair::mq
Pluginclass
- Inherited by
fair::mq::plugins::Config,fair::mq::plugins::Control
Base class for FairMQ plugins.
The plugin base class encapsulates the plugin metadata.
Types
using Version = tools::VersionNo comment in the header yet.
using DeviceState = fair::mq::PluginServices::DeviceStateNo comment in the header yet.
using DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransitionNo comment in the header yet.
Functions
Plugin() = deleteNo comment in the header yet.
Plugin(
std::string name,
Version version,
std::string maintainer,
std::string homepage,
PluginServices* pluginServices
)No comment in the header yet.
Plugin(const Plugin&) = deleteNo comment in the header yet.
Plugin(Plugin&&) = deleteNo comment in the header yet.
Plugin& operator=(const Plugin&) = deleteNo comment in the header yet.
Plugin& operator=(Plugin&&) = deleteNo comment in the header yet.
virtual ~Plugin()No comment in the header yet.
auto GetName() const -> const std::string &No comment in the header yet.
auto GetVersion() const -> const VersionNo comment in the header yet.
auto GetMaintainer() const -> const std::string &No comment in the header yet.
auto GetHomepage() const -> const std::string &No comment in the header yet.
auto ToDeviceState(const std::string& state) const -> DeviceStateNo comment in the header yet.
auto ToDeviceStateTransition(const std::string& transition) const -> DeviceStateTransitionNo comment in the header yet.
auto ToStr(DeviceState state) const -> std::stringNo comment in the header yet.
auto ToStr(DeviceStateTransition transition) const -> std::stringNo comment in the header yet.
auto GetCurrentDeviceState() const -> DeviceStateNo comment in the header yet.
auto TakeDeviceControl() -> voidNo comment in the header yet.
auto StealDeviceControl() -> voidNo comment in the header yet.
auto ReleaseDeviceControl() -> voidNo comment in the header yet.
auto ChangeDeviceState(const DeviceStateTransition next) -> boolNo comment in the header yet.
auto SubscribeToDeviceStateChange(std::function<void(DeviceState)> callback) -> voidNo comment in the header yet.
auto UnsubscribeFromDeviceStateChange() -> voidNo comment in the header yet.
auto GetNumberOfConnectedPeers(
const std::string& channelName,
int index = 0
) -> unsigned longNo comment in the header yet.
auto PropertyExists(const std::string& key) -> intNo comment in the header yet.
template<typename T>
T GetProperty(const std::string& key) constNo comment in the header yet.
template<typename T>
T GetProperty(const std::string& key, const T& ifNotFound) constNo comment in the header yet.
std::string GetPropertyAsString(const std::string& key) constNo comment in the header yet.
std::string GetPropertyAsString(
const std::string& key,
const std::string& ifNotFound
) constNo comment in the header yet.
fair::mq::Properties GetProperties(const std::string& q) constNo comment in the header yet.
fair::mq::Properties GetPropertiesStartingWith(const std::string& q) constNo comment in the header yet.
std::map<std::string, std::string> GetPropertiesAsString(const std::string& q) constNo comment in the header yet.
std::map<std::string, std::string> GetPropertiesAsStringStartingWith(const std::string& q) constNo comment in the header yet.
auto GetChannelInfo() const -> std::unordered_map< std::string, int >No comment in the header yet.
auto GetPropertyKeys() const -> std::vector< std::string >No comment in the header yet.
template<typename T>
auto SetProperty(const std::string& key, T val) -> voidNo comment in the header yet.
void SetProperties(const fair::mq::Properties& props)No comment in the header yet.
template<typename T>
bool UpdateProperty(const std::string& key, T val)No comment in the header yet.
bool UpdateProperties(const fair::mq::Properties& input)No comment in the header yet.
void DeleteProperty(const std::string& key)No comment in the header yet.
template<typename T>
auto SubscribeToPropertyChange(std::function<void(const std::string&key, T newValue)> callback) -> voidNo comment in the header yet.
template<typename T>
auto UnsubscribeFromPropertyChange() -> voidNo comment in the header yet.
auto SubscribeToPropertyChangeAsString(std::function<void(const std::string&key, std::string newValue)> callback) -> voidNo comment in the header yet.
auto UnsubscribeFromPropertyChangeAsString() -> voidNo comment in the header yet.
auto CycleLogConsoleSeverityUp() -> voidNo comment in the header yet.
auto CycleLogConsoleSeverityDown() -> voidNo comment in the header yet.
auto CycleLogVerbosityUp() -> voidNo comment in the header yet.
auto CycleLogVerbosityDown() -> voidNo comment in the header yet.
Static functions
static auto NoProgramOptions() -> ProgOptionsNo comment in the header yet.
Friends
friend auto operator==(const Plugin& lhs, const Plugin& rhs) -> boolNo comment in the header yet.
friend auto operator!=(const Plugin& lhs, const Plugin& rhs) -> boolNo comment in the header yet.
friend auto operator<<(std::ostream& os, const Plugin& p) -> std::ostream &No comment in the header yet.