JANA/Services/JWiringService.h

0001 // Copyright 2024, Jefferson Science Associates, LLC.
0002 // Subject to the terms in the LICENSE file found in the top-level directory.
0003 // Created by Nathan Brei
0004
0005 #pragma once
0006 #include <JANA/JService.h>
0007 #include <toml.hpp>
0008 #include <string>
0009 #include <map>
0010 #include <vector>
0011 #include <memory>
0012
0013 namespace jana::services {
0014
0015
0016 class JWiringService : public JService {
0017
0018 public:
0019     struct Wiring {
0020         std::string plugin_name;
0021         std::string type_name;
0022         std::string prefix;
0023         JEventLevel level = JEventLevel::None;
0024         std::vector<std::string> input_names;
0025         std::vector<JEventLevel> input_levels;
0026         std::vector<std::vector<std::string>> variadic_input_names;
0027         std::vector<JEventLevel> variadic_input_levels;
0028         std::vector<std::string> output_names;
0029         std::vector<JEventLevel> output_levels;
0030         std::vector<std::vector<std::string>> variadic_output_names;
0031         std::map<std::string, std::string> configs;
0032     };
0033
0034 private:
0035     Parameter<std::string> m_wirings_input_file {this, "jana:wiring_file", "",
0036         "Path to TOML file containing wiring definitions"};
0037
0038     Parameter<bool> m_strict_inheritance {this, "jana:wiring_strictness", true,
0039         "Allow multiple definitions inside wiring files"};
0040
0041     std::vector<std::unique_ptr<Wiring>> m_wirings;
0042     std::map<std::string, Wiring*> m_wirings_from_prefix;
0043     std::map<std::pair<std::string,std::string>, std::vector<Wiring*>> m_wirings_from_type_and_plugin_names;
0044     std::vector<Wiring*> m_no_wirings;
0045     std::map<std::string, std::string> m_shared_parameters;
0046
0047 public:
0048     JWiringService();
0049     void Init() override;
0050
0051     void AddWirings(std::vector<std::unique_ptr<Wiring>>& wirings, const std::string& source);
0052     void AddWirings(const toml::table& table, const std::string& source);
0053     void AddWiringFile(const std::string& filename);
0054
0055     void AddSharedParameters(const toml::table& table, const std::string& source);
0056     const std::map<std::string, std::string>& GetSharedParameters() const;
0057
0058     const Wiring*
0059     GetWiring(const std::string& prefix) const;
0060
0061     const std::vector<Wiring*>&
0062     GetWirings(const std::string& plugin_name, const std::string& type_name) const;
0063
0064     const std::vector<std::unique_ptr<Wiring>>&
0065     GetWirings() const { return m_wirings; }
0066
0067     static void Overlay(Wiring& above, const Wiring& below);
0068 };
0069
0070 } // namespace jana::services
0071