Gcrone/private session

CMakeLists.txt

@@ -19,6 +19,7 @@ find_package(Boost COMPONENTS unit_test_framework program_options REQUIRED)
 daq_add_dal_library(application.schema.xml hermes.schema.xml fdmodules.schema.xml trigger.schema.xml wiec.schema.xml PDS.schema.xml tde.schema.xml CTB.schema.xml CIB.schema.xml
   NAMESPACE dunedaq::appmodel DEP_PKGS confmodel
   SOURCES
+  ConfigurationHelper.cpp
 	ConfigObjectFactory.cpp
 	CRTReaderApplication.cpp
 	CTBApplication.cpp
@@ -43,7 +44,7 @@ daq_add_dal_library(application.schema.xml hermes.schema.xml fdmodules.schema.xm
 	TRMonReqApplication.cpp
 	WIECApplication.cpp
 	CIBApplication.cpp
-  LINK_LIBRARIES conffwk::conffwk fmt::fmt logging::logging oks::oks ers::ers )
+	LINK_LIBRARIES confmodel::confmodel conffwk::conffwk fmt::fmt logging::logging oks::oks ers::ers )
 
 daq_add_application(getAppsArguments get_apps_arguments.cxx
   LINK_LIBRARIES confmodel::confmodel appmodel_dal conffwk::conffwk)

docs/SmartDaqApplication.md

@@ -14,6 +14,10 @@ This section will use the "[DFOApplication](https://github.com/DUNE-DAQ/appmodel
 Once instantiated at the start of `generate_modules`, it offers a set of methods to facilitate the creation of configurarion objects, queues and network connections.
 
 
+### The generate_modules method
+
+The boilerplate code above references a  method called generate_modules() which you have to supply. The `confdb` and `dbfile` arguments are used to create configuration objects in the database (see below). The helper argument is a pointer to a helper object with methods for extracting configuration data not belonging to the current application.
+
 ### Creating a module
 
 ```C++
@@ -84,4 +88,4 @@ Once the fixed connections are retrieved using the network rules, the module's i
 
 ### Summary
 
-These basic steps are repeated in all SmartDaqApplication instances, with differences depending on the specific applciation being implemented. The DFOApplication is one of the simplest applications in the system, but it demonstrates the basic logic followed by all SmartDaqApplications.
+These basic steps are repeated in all SmartDaqApplication instances, with differences depending on the specific applciation being implemented. The DFOApplication is one of the simplest applications in the system, but it demonstrates the basic logic followed by all SmartDaqApplications.

include/appmodel/ConfigurationHelper.hpp

@@ -0,0 +1,130 @@
+/**
+ * @file ConfigurationHelper.hpp
+ *
+ * Define a helper class for SmartDaqApplication module generators
+ *
+ * This is part of the DUNE DAQ Software Suite, copyright 2023.
+ * Licensing/copyright details are in the COPYING file that you should have
+ * received with this code.
+ */
+#ifndef APPMODEL_INCLUDE_CONFIGURATIONHELPER_HPP_
+#define APPMODEL_INCLUDE_CONFIGURATIONHELPER_HPP_
+
+#include <cstdint>
+#include <map>
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace dunedaq::confmodel {
+  class Session;
+  class Service;
+} //namespace dunedaq::confmodel
+namespace dunedaq::conffwk {
+  class DalObject;
+} // namespace dunedaq::conffwk
+
+namespace dunedaq::appmodel {
+  class NetworkConnectionDescriptor;
+  class SourceIDConf;
+
+  /// Helper class to extract information from Session object without
+  /// exposing the Session to user code
+  ///
+  /// Provides methods that loop over all applications in the session
+  /// to get source IDs etc. avoiding the need for individual
+  /// application's code to access configuration objects of other
+  /// applications.
+  class ConfigurationHelper {
+  public:
+    explicit ConfigurationHelper(const confmodel::Session* ses)
+      : m_session(ses) {}
+
+
+    /// @brief Get the exposed Services of all network connections
+    /// with given data_type from all smart daq applications of given
+    /// class
+    ///
+    /// @param app_class  Dal class of applications to match
+    /// @param data_type  Data type of network descriptor to match
+    ///
+    /// @returns  A vector of pointers to matching Services
+    std::vector<const confmodel::Service*> get_services(std::string app_class,
+                                                        std::string data_type);
+
+
+    /// @brief Get all NetworkConnectionDescriptors with given
+    /// data_type from all applications of given type
+    ///
+    /// @param data_type  Data type to match in network descriptor
+    /// @param app_class  Optional dal class name to match
+    ///
+    /// @returns a vector of application uid / network descriptor pairs
+    std::vector<std::pair<std::string, const appmodel::NetworkConnectionDescriptor*>>
+    get_netdescriptors (
+      const std::string& data_type,
+      const std::string& app_class="");
+
+
+    /// @brief Get the source ids of all DetectorStreams in the Session
+    ///
+    /// @returns A map of application uids to vectors of streams that
+    ///         they contain
+    std::map<std::string, std::vector<uint32_t>> get_stream_source_ids();
+
+
+    /// @brief Get the source ids of all the TP streams in all
+    /// ReadoutApplications and TriggerApplications
+    ///
+    /// @returns  A map of application uids to vectors of contained
+    ///          TP source ids
+    std::map<std::string, std::vector<const SourceIDConf*>>
+    get_tp_source_ids();
+
+
+    /// @brief Get list of uids of applications that match given type
+    ///
+    /// @param app_class  Class of applications to match
+    ///
+    /// @returns  A vector of uids of matching applications
+    std::vector<std::string> get_app_uids(std::string app_class="");
+
+
+    /// @brief Get list of source ids for applications that match
+    ///       given type
+    ///
+    /// @returns A map of application uids to application source ids
+    std::map<std::string, const SourceIDConf*>  get_app_source_ids(
+      std::string app_class="");
+
+
+    /// @brief Get list of all source ids for applications that match
+    ///       given type. Follows any single value SourceIDConf relationship
+    ///
+    /// NB: Does not look at multi-value SourceIDConf relationships
+    ///
+    /// @returns  A map of application uids to maps relationship to contained
+    ///          source ids
+    std::map<std::string, std::map<std::string, const SourceIDConf*>>
+    get_all_app_source_ids(std::string app_class="");
+
+
+    /// @brief Check the enabled state of the given item
+    ///
+    /// @returns True if the object is not disabled
+    inline bool is_enabled(const conffwk::DalObject* item) {
+      return !is_disabled(item);
+    }
+
+    /// @brief Check the enabled state of the given item
+    ///
+    /// @returns True if the object is disabled
+    bool is_disabled(const conffwk::DalObject* item);
+
+  private:
+    const confmodel::Session* m_session;
+  };
+
+} //namespace dunedaq::appmodel
+
+#endif // APPMODEL_INCLUDE_CONFIGURATIONHELPER_HPP_

include/appmodel/appmodelIssues.hpp

@@ -26,7 +26,18 @@ namespace dunedaq {
         "Method '" << method_name << "' was called but is not implemented in this class",
         ((std::string)method_name))
 
-}
+
+  ERS_DECLARE_ISSUE(appmodel,
+                    NotSmart,
+                    "Object is not a SmartDaqApplication: " << obj,
+                    ((std::string)obj))
+
+  ERS_DECLARE_ISSUE(appmodel,
+                    BadD2d,
+                    "Contained object is not a DetectorToDaqConnection: " << obj,
+                    ((std::string)obj))
+
+} // namespace dunedaq
 
 
 #endif // APPDALISSUES_HPP

pybindsrc/dal_methods.cpp

@@ -37,7 +37,8 @@ namespace dunedaq::appmodel::python {
     auto session =
       const_cast<conffwk::Configuration&>(confdb).get<confmodel::Session>(session_id);
 
-    app->generate_modules(session);
+    auto helper = std::make_shared<ConfigurationHelper>(session);
+    app->generate_modules(helper);
     std::vector<ObjectLocator> mods;
     for (auto mod : app->get_modules()) {
       mods.push_back({mod->UID(),mod->class_name()});

schema/appmodel/CIB.schema.xml

@@ -97,7 +97,7 @@
 
   <!-- generating methods -->
   <method name="generate_modules" description="Generate DaqModule dal objects for streams of the application on the fly">
-   <method-implementation language="c++" prototype="void generate_modules(const confmodel::Session*) const override" body=""/>
+   <method-implementation language="c++" prototype="void generate_modules(std::shared_ptr&lt;appmodel::ConfigurationHelper&gt;) const override" body=""/>
   </method>
 
   <method name="contained_resources" description="">

schema/appmodel/CTB.schema.xml

@@ -96,7 +96,7 @@
   <relationship name="link_handler" class-type="DataHandlerConf" low-cc="one" high-cc="one" is-composite="no" is-exclusive="no" is-dependent="no"/>
   <relationship name="LLT_source" description="The source ID of the smart application itself will be used for HLT. &#xA;We need an additional source of the LLT, and this is that. " class-type="SourceIDConf" low-cc="one" high-cc="one" is-composite="no" is-exclusive="no" is-dependent="no"/>
   <method name="generate_modules" description="Generate DaqModule dal objects for streams of the application on the fly">
-   <method-implementation language="c++" prototype="void generate_modules(const confmodel::Session*) const override" body=""/>
+   <method-implementation language="c++" prototype="void generate_modules(std::shared_ptr&lt;appmodel::ConfigurationHelper&gt;) const override" body=""/>
   </method>
   <method name="get_sources" description="The CTB HSI has two sources, one for HLT and one for LLT. &#xA;This methods gets the right information in a way that makes easy to loop over the information">
    <method-implementation language="C++" prototype="std::vector&lt;std::pair&lt;std::string, const appmodel::SourceIDConf*&gt;&gt; get_sources() const" body="return {{ &quot;HLT&quot;,  get_source_id() }, &#xA;             { &quot;LLT&quot;, get_LLT_source() }};"/>

schema/appmodel/PDS.schema.xml

@@ -96,9 +96,8 @@
   <relationship name="configuration" class-type="DaphneConf" low-cc="one" high-cc="one" is-composite="no" is-exclusive="no" is-dependent="no"/>
   <relationship name="detector_connections" description="List of detector components controlled by this application" class-type="DetectorToDaqConnection" low-cc="zero" high-cc="many" is-composite="no" is-exclusive="no" is-dependent="no"/>
   <relationship name="hermes_module_conf" class-type="HermesModuleConf" low-cc="zero" high-cc="one" is-composite="no" is-exclusive="no" is-dependent="no"/>
-
   <method name="generate_modules" description="Generate DaqModule dal objects for streams of the application on the fly">
-   <method-implementation language="c++" prototype="void generate_modules(const confmodel::Session*) const override" body=""/>
+   <method-implementation language="c++" prototype="void generate_modules(std::shared_ptr&lt;appmodel::ConfigurationHelper&gt;) const override" body="BEGIN_HEADER_PROLOGUE&#xA;#include &quot;appmodel/ConfigurationHelper.hpp&quot;&#xA;END_HEADER_PROLOGUE"/>
   </method>
   <method name="contained_resources" description="">
    <method-implementation language="c++" prototype="virtual std::vector&lt;const Resource*&gt; contained_resources() const override" body=""/>