Merge pull request #90 from DUNE-DAQ/gcrone/enable_disable_methods

Add enable and disable methods to ResourceTree

Author: mroda88

pybindsrc/dal_methods.cpp

@@ -59,6 +59,35 @@ namespace dunedaq::confmodel::python {
     return apps;
   }
 
+
+  void disable_component(Configuration& db,
+                         const std::string& session_id,
+                         const std::string& component_id) {
+    auto session_ptr = const_cast<dunedaq::confmodel::Session*>(db.get<dunedaq::confmodel::Session>(session_id));
+    auto component_ptr = db.get<dunedaq::confmodel::Resource>(component_id);
+    if (session_ptr == nullptr) {
+      throw (std::runtime_error(std::format("Session {} not found", session_id)));
+    }
+    if (component_ptr == nullptr) {
+      throw (std::runtime_error(std::format("Component {} not found", component_id)));
+    }
+    session_ptr->disable(component_ptr);
+  }
+  void enable_component(Configuration& db,
+                         const std::string& session_id,
+                         const std::string& component_id) {
+    auto session_ptr = const_cast<dunedaq::confmodel::Session*>(db.get<dunedaq::confmodel::Session>(session_id));
+    auto component_ptr = db.get<dunedaq::confmodel::Resource>(component_id);
+    if (session_ptr == nullptr) {
+      throw (std::runtime_error(std::format("Session {} not found", session_id)));
+    }
+    if (component_ptr == nullptr) {
+      throw (std::runtime_error(std::format("Component {} not found", component_id)));
+    }
+    session_ptr->enable(component_ptr);
+  }
+
+
   bool component_disabled(Configuration& db,
                           const std::string& session_id,
                           const std::string& component_id) {
@@ -111,11 +140,11 @@ namespace dunedaq::confmodel::python {
     return app->construct_commandline_parameters(db, session);
   }
 
-  std::vector<std::string> rc_application_construct_commandline_parameters(const Configuration& db,
+  std::vector<std::string> rc_application_construct_commandline_parameters(Configuration& db,
                                                                            const std::string& session_id,
                                                                            const std::string& app_id) {
-    const auto* app = const_cast<Configuration&>(db).get<dunedaq::confmodel::RCApplication>(app_id);
-    const auto* session = const_cast<Configuration&>(db).get<dunedaq::confmodel::Session>(session_id);
+    const auto* app = db.get<dunedaq::confmodel::RCApplication>(app_id);
+    const auto* session = db.get<dunedaq::confmodel::Session>(session_id);
     return app->construct_commandline_parameters(db, session);
   }
 
@@ -179,6 +208,9 @@ register_dal_methods(py::module& m)
   m.def("session_get_all_applications", &session_get_all_applications, "Get list of ALL applications (regardless of enabled/disabled state) in the requested session");
   m.def("session_get_enabled_applications", &session_get_enabled_applications, "Get list of enabled applications in the requested session");
 
+  m.def("disable_component", &disable_component, "Disable a Resource-derived object (e.g. a Segment)");
+  m.def("enable_component", &enable_component, "Enable a Resource-derived object (e.g. a Segment)");
+
   m.def("component_disabled", &component_disabled, "Determine if a Resource-derived object (e.g. a Segment) has been disabled");
   m.def("component_get_parents", &component_get_parents, "Get the Resource-derived class instances of the parent(s) of the Resource-derived object in question");
   m.def("daqapp_get_used_resources", &daq_application_get_used_hostresources, "Get list of HostResources used by DAQApplication");

schema/confmodel/dunedaq.schema.xml

@@ -80,7 +80,7 @@
 
 <oks-schema>
 
-<info name="" type="" num-of-items="49" oks-format="schema" oks-version="862f2957270" created-by="jcfree" created-on="mu2edaq13.fnal.gov" creation-time="20230123T223700" last-modified-by="gjc" last-modified-on="latitude" last-modification-time="20250923T103939"/>
+<info name="" type="" num-of-items="49" oks-format="schema" oks-version="862f2957270" created-by="jcfree" created-on="mu2edaq13.fnal.gov" creation-time="20230123T223700" last-modified-by="gjc" last-modified-on="latitude" last-modification-time="20260218T122834"/>
 
  <class name="ActionPlan" description="A set of steps for an application to carry out a command">
   <attribute name="execution_policy" description="How the application should dispatch the command to modules matched by each step of the ActionPlan" type="enum" range="modules-in-parallel,modules-in-series" init-value="modules-in-parallel"/>
@@ -369,6 +369,12 @@
   <method name="resource_root" description="Pure virtual method to get the ResourceSet at the root of the ResourceTree.">
    <method-implementation language="c++" prototype="virtual const ResourceSet* resource_root() const = 0" body=""/>
   </method>
+  <method name="disable" description="Add a component to the disabled relationship and recalculate the disabled tree">
+   <method-implementation language="c++" prototype="void disable(const Resource*)" body=""/>
+  </method>
+  <method name="enable" description="">
+   <method-implementation language="c++" prototype="void enable(const Resource*)" body=""/>
+  </method>
  </class>
 
  <class name="Segment" description="Logical sub division of the configuration that can be enabled/disabled as a group">

src/dalMethods.cpp

@@ -392,6 +392,34 @@ std::string OpMonURI::get_URI( const std::string & /* app */) const {
   return "stdout://";
 }
 
+
+// ========================================================================
+void ResourceTree::disable(const Resource* res) {
+  auto disabled_vec = get_disabled();
+  for (auto disabled_resource : disabled_vec) {
+    if (disabled_resource == res) {
+      return;
+    }
+  }
+  disabled_vec.push_back(res);
+
+  set_disabled(disabled_vec);
+  configuration().update<ResourceTree>({UID()}, {}, {});
+
+  m_disabled_resources.update(resource_root(), disabled_vec);
+}
+void ResourceTree::enable(const Resource* res) {
+  auto disabled_vec = get_disabled();
+  auto count = std::erase(disabled_vec, res);
+  if (count == 0) {
+    return;
+  }
+  set_disabled(disabled_vec);
+  configuration().update<ResourceTree>({UID()}, {}, {});
+
+  m_disabled_resources.update(resource_root(), disabled_vec);
+}
+
 bool Resource::is_disabled(const dunedaq::confmodel::ResourceTree& holder) const {
   return (!holder.disabled_components().is_enabled(this));
 }