RSDK-6484 - add reconfigurable base class (#212)

Author: stuqdog

src/viam/examples/modules/complex/base/impl.hpp

@@ -4,14 +4,15 @@
 #include <viam/sdk/components/component.hpp>
 #include <viam/sdk/components/motor/motor.hpp>
 #include <viam/sdk/config/resource.hpp>
+#include <viam/sdk/resource/reconfigurable.hpp>
 #include <viam/sdk/resource/resource.hpp>
 
 using namespace viam::sdk;
 
 // `MyBase` inherits from the `Base` class defined in the viam C++ SDK and
 // implements some of the relevant methods along with `reconfigure`. It also
 // specifies a static `validate` method that checks config validity.
-class MyBase : public Base {
+class MyBase : public Base, public Reconfigurable {
    public:
     MyBase(const Dependencies& deps, const ResourceConfig& cfg) : Base(cfg.name()) {
         this->reconfigure(deps, cfg);

src/viam/examples/modules/complex/gizmo/impl.hpp

@@ -3,6 +3,7 @@
 #include <vector>
 
 #include <viam/sdk/common/proto_type.hpp>
+#include <viam/sdk/resource/reconfigurable.hpp>
 
 #include "api.hpp"
 
@@ -11,7 +12,7 @@ using namespace viam::sdk;
 // MyGizmo inherits from the `Gizmo` class defined in `api.hpp` and implements
 // all relevant methods along with `reconfigure`. It also specifies a static
 // `validate` method that checks config validity.
-class MyGizmo : public Gizmo {
+class MyGizmo : public Gizmo, public Reconfigurable {
    public:
     MyGizmo(std::string name, std::string arg1) : Gizmo(std::move(name)), arg1_(std::move(arg1)){};
     MyGizmo(const Dependencies& deps, const ResourceConfig& cfg) : Gizmo(cfg.name()) {

src/viam/examples/modules/complex/summation/impl.hpp

@@ -2,13 +2,15 @@
 
 #include <vector>
 
+#include <viam/sdk/resource/reconfigurable.hpp>
+
 #include "api.hpp"
 
 using namespace viam::sdk;
 
 // MySummation inherits from the `Summation` class defined in `api.hpp` and
 // implements all relevant methods along with `reconfigure`.
-class MySummation : public Summation {
+class MySummation : public Summation, public Reconfigurable {
    public:
     MySummation(std::string name, bool subtract)
         : Summation(std::move(name)), subtract_(subtract){};

src/viam/examples/modules/simple/main.cpp

@@ -1,6 +1,5 @@
 #include <iostream>
 #include <memory>
-#include <signal.h>
 #include <sstream>
 
 #include <boost/log/trivial.hpp>
@@ -15,6 +14,7 @@
 #include <viam/sdk/module/module.hpp>
 #include <viam/sdk/module/service.hpp>
 #include <viam/sdk/registry/registry.hpp>
+#include <viam/sdk/resource/reconfigurable.hpp>
 #include <viam/sdk/resource/resource.hpp>
 #include <viam/sdk/rpc/dial.hpp>
 #include <viam/sdk/rpc/server.hpp>
@@ -26,9 +26,9 @@ using namespace viam::sdk;
 // Printer is a modular resource that can print a to_print value to STDOUT when
 // a DoCommand request is received or when reconfiguring. The to_print value
 // must be provided as an attribute in the config.
-class Printer : public GenericService {
+class Printer : public GenericService, public Reconfigurable {
    public:
-    void reconfigure(Dependencies deps, ResourceConfig cfg) {
+    void reconfigure(const Dependencies& deps, const ResourceConfig& cfg) {
         std::cout << "Printer " << Resource::name() << " is reconfiguring" << std::endl;
         for (auto& dep : deps) {
             std::cout << "dependency: " << dep.first.to_string() << std::endl;

src/viam/examples/modules/tflite/main.cpp

@@ -30,6 +30,7 @@
 #include <viam/sdk/config/resource.hpp>
 #include <viam/sdk/module/service.hpp>
 #include <viam/sdk/registry/registry.hpp>
+#include <viam/sdk/resource/reconfigurable.hpp>
 #include <viam/sdk/resource/stoppable.hpp>
 #include <viam/sdk/rpc/server.hpp>
 #include <viam/sdk/services/mlmodel/mlmodel.hpp>
@@ -58,7 +59,9 @@ constexpr char service_name[] = "example_mlmodelservice_tflite";
 //      with the model.
 //
 // Any additional configuration fields are ignored.
-class MLModelServiceTFLite : public vsdk::MLModelService, public vsdk::Stoppable {
+class MLModelServiceTFLite : public vsdk::MLModelService,
+                             public vsdk::Stoppable,
+                             public vsdk::Reconfigurable {
     class write_to_tflite_tensor_visitor_;
 
    public:

src/viam/sdk/CMakeLists.txt

@@ -82,6 +82,7 @@ target_sources(viamsdk
     module/signal_manager.cpp
     referenceframe/frame.cpp
     registry/registry.cpp
+    resource/reconfigurable.cpp
     resource/resource.cpp
     resource/resource_api.cpp
     resource/resource_manager.cpp
@@ -155,6 +156,7 @@ target_sources(viamsdk
       ../../viam/sdk/module/signal_manager.hpp
       ../../viam/sdk/referenceframe/frame.hpp
       ../../viam/sdk/registry/registry.hpp
+      ../../viam/sdk/resource/reconfigurable.hpp
       ../../viam/sdk/resource/resource.hpp
       ../../viam/sdk/resource/resource_api.hpp
       ../../viam/sdk/resource/resource_manager.hpp

src/viam/sdk/module/service.cpp

@@ -1,11 +1,8 @@
 #include <viam/sdk/module/service.hpp>
 
 #include <exception>
-#include <fstream>
-#include <iostream>
 #include <memory>
 #include <sstream>
-#include <stdexcept>
 #include <string>
 #include <sys/socket.h>
 #include <sys/stat.h>
@@ -33,6 +30,7 @@
 #include <viam/sdk/config/resource.hpp>
 #include <viam/sdk/module/handler_map.hpp>
 #include <viam/sdk/registry/registry.hpp>
+#include <viam/sdk/resource/reconfigurable.hpp>
 #include <viam/sdk/resource/resource.hpp>
 #include <viam/sdk/resource/resource_api.hpp>
 #include <viam/sdk/resource/resource_manager.hpp>
@@ -121,7 +119,7 @@ ::grpc::Status ModuleService::ReconfigureResource(
                                 " as it doesn't exist.");
     }
     try {
-        res->reconfigure(deps, cfg);
+        Reconfigurable::reconfigure_if_reconfigurable(res, deps, cfg);
         return grpc::Status();
     } catch (const std::exception& exc) {
         return grpc::Status(::grpc::INTERNAL, exc.what());

src/viam/sdk/resource/reconfigurable.cpp

@@ -0,0 +1,21 @@
+#include <viam/sdk/resource/reconfigurable.hpp>
+
+#include <memory>
+
+namespace viam {
+namespace sdk {
+
+Reconfigurable::~Reconfigurable() = default;
+Reconfigurable::Reconfigurable() = default;
+
+void Reconfigurable::reconfigure_if_reconfigurable(const std::shared_ptr<Resource>& resource,
+                                                   const Dependencies& deps,
+                                                   const ResourceConfig& cfg) {
+    auto reconfigurable_res = std::dynamic_pointer_cast<Reconfigurable>(resource);
+    if (reconfigurable_res) {
+        reconfigurable_res->reconfigure(deps, cfg);
+    }
+}
+
+}  // namespace sdk
+}  // namespace viam

src/viam/sdk/resource/reconfigurable.hpp

@@ -0,0 +1,31 @@
+#pragma once
+
+#include <viam/sdk/config/resource.hpp>
+#include <viam/sdk/resource/resource.hpp>
+
+namespace viam {
+namespace sdk {
+
+class Reconfigurable {
+   public:
+    virtual ~Reconfigurable();
+
+    /// @brief Reconfigures a resource.
+    /// @param deps Dependencies of the resource.
+    /// @param cfg The resource's config.
+    virtual void reconfigure(const Dependencies& deps, const ResourceConfig& cfg) = 0;
+
+    /// @brief Reconfigures a resource if it is Reconfigurable.
+    /// @param resource the Resource to reconfigure.
+    /// @param deps Dependencies of the resource.
+    /// @param cfg The resource's config.
+    static void reconfigure_if_reconfigurable(const std::shared_ptr<Resource>& resource,
+                                              const Dependencies& deps,
+                                              const ResourceConfig& cfg);
+
+   protected:
+    explicit Reconfigurable();
+};
+
+}  // namespace sdk
+}  // namespace viam

src/viam/sdk/resource/resource.cpp

@@ -1,8 +1,5 @@
 #include <viam/sdk/resource/resource.hpp>
 
-#include <stdexcept>
-#include <unordered_map>
-
 #include <grpcpp/support/status.h>
 
 #include <viam/sdk/common/proto_type.hpp>
@@ -21,8 +18,6 @@ std::string Resource::name() const {
     return name_;
 }
 
-void Resource::reconfigure(const Dependencies& deps, const ResourceConfig& cfg){};
-
 ResourceName Resource::get_resource_name(std::string name) const {
     ResourceName r;
     *r.mutable_namespace_() = kRDK;

src/viam/sdk/resource/resource.hpp

@@ -25,11 +25,6 @@ class Resource {
     /// @brief Returns a `ResourceName` for a particular resource name.
     virtual viam::common::v1::ResourceName get_resource_name(std::string name) const;
 
-    /// @brief Reconfigures a resource.
-    /// @param deps Dependencies of the resource.
-    /// @param cfg The resource's config.
-    virtual void reconfigure(const Dependencies& deps, const ResourceConfig& cfg);
-
     /// @brief Return the resource's name.
     virtual std::string name() const;