feat: implement Get3DModels for arm

Author: mattmacf98

src/viam/sdk/components/arm.hpp

@@ -3,6 +3,7 @@
 /// @brief Defines an `Arm` component
 #pragma once
 
+#include <common/v1/common.pb.h>
 #include <string>
 
 #include <boost/optional/optional.hpp>
@@ -142,6 +143,17 @@ class Arm : public Component, public Stoppable {
         return get_kinematics({});
     }
 
+    /// @brief Returns `3DModel`s associated with the calling arm
+    /// @param extra Any additional arguments to the method
+    /// @return A map of `3DModel`s associated with the calling arm
+    virtual std::map<std::string, common::v1::Mesh> get_3d_models(const ProtoStruct& extra) = 0;
+
+    /// @brief Returns `3DModel`s associated with the calling arm
+    /// @return A map of `3DModel`s associated with the calling arm
+    inline std::map<std::string, common::v1::Mesh> get_3d_models() {
+        return get_3d_models({});
+    }
+
     /// @brief Returns `GeometryConfig`s associated with the calling arm
     inline std::vector<GeometryConfig> get_geometries() {
         return get_geometries({});

src/viam/sdk/components/private/arm_client.cpp

@@ -106,6 +106,15 @@ Arm::KinematicsData ArmClient::get_kinematics(const ProtoStruct& extra) {
         });
 }
 
+std::map<std::string, common::v1::Mesh> ArmClient::get_3d_models(const ProtoStruct& extra) {
+    return make_client_helper(this, *stub_, &StubType::Get3DModels)
+        .with(extra)
+        .invoke([](auto& response) {
+            return std::map<std::string, common::v1::Mesh>(response.models().begin(),
+                                                           response.models().end());
+        });
+}
+
 std::vector<GeometryConfig> ArmClient::get_geometries(const ProtoStruct& extra) {
     return make_client_helper(this, *stub_, &StubType::GetGeometries)
         .with(extra)

src/viam/sdk/components/private/arm_client.hpp

@@ -33,10 +33,12 @@ class ArmClient : public Arm {
     void stop(const ProtoStruct& extra) override;
     ProtoStruct do_command(const ProtoStruct& command) override;
     Arm::KinematicsData get_kinematics(const ProtoStruct& extra) override;
+    std::map<std::string, common::v1::Mesh> get_3d_models(const ProtoStruct& extra) override;
     std::vector<GeometryConfig> get_geometries(const ProtoStruct& extra) override;
 
     // Using declarations to introduce convenience overloads of interface which do not need to be
     // passed the ProtoStruct parameter.
+    using Arm::get_3d_models;
     using Arm::get_end_position;
     using Arm::get_geometries;
     using Arm::get_joint_positions;

src/viam/sdk/components/private/arm_server.cpp

@@ -135,6 +135,18 @@ ::grpc::Status ArmServer::GetKinematics(
     });
 }
 
+::grpc::Status ArmServer::Get3DModels(::grpc::ServerContext*,
+                                      const ::viam::common::v1::Get3DModelsRequest* request,
+                                      ::viam::common::v1::Get3DModelsResponse* response) noexcept {
+    return make_service_helper<Arm>(
+        "ArmServer::Get3DModels", this, request)([&](auto& helper, auto& arm) {
+        const std::map<std::string, common::v1::Mesh> models =
+            arm->get_3d_models(helper.getExtra());
+
+        response->mutable_models()->insert(models.begin(), models.end());
+    });
+}
+
 ::grpc::Status ArmServer::GetGeometries(
     ::grpc::ServerContext*,
     const ::viam::common::v1::GetGeometriesRequest* request,

src/viam/sdk/components/private/arm_server.hpp

@@ -67,6 +67,10 @@ class ArmServer : public ResourceServer, public viam::component::arm::v1::ArmSer
         const ::viam::common::v1::GetKinematicsRequest* request,
         ::viam::common::v1::GetKinematicsResponse* response) noexcept override;
 
+    ::grpc::Status Get3DModels(::grpc::ServerContext* context,
+                               const ::viam::common::v1::Get3DModelsRequest* request,
+                               ::viam::common::v1::Get3DModelsResponse* response) noexcept override;
+
     ::grpc::Status GetGeometries(
         ::grpc::ServerContext* context,
         const ::viam::common::v1::GetGeometriesRequest* request,

src/viam/sdk/tests/Testing/Temporary/CTestCostData.txt

@@ -0,0 +1 @@
+---

src/viam/sdk/tests/Testing/Temporary/LastTest.log

@@ -0,0 +1,3 @@
+Start testing: Nov 18 09:37 EST
+----------------------------------------------------------
+End testing: Nov 18 09:37 EST

src/viam/sdk/tests/mocks/mock_arm.cpp

@@ -7,6 +7,10 @@ namespace viam {
 namespace sdktests {
 namespace arm {
 
+std::map<std::string, common::v1::Mesh> fake_3d_models() {
+    return {{"model1", common::v1::Mesh::default_instance()}};
+}
+
 sdk::Arm::KinematicsData fake_kinematics() {
     return sdk::Arm::KinematicsDataSVA{{std::vector<unsigned char>{1, 2, 3, 4}}};
 }
@@ -59,6 +63,10 @@ std::vector<sdk::GeometryConfig> MockArm::get_geometries(const sdk::ProtoStruct&
     return fake_geometries();
 }
 
+std::map<std::string, common::v1::Mesh> MockArm::get_3d_models(const sdk::ProtoStruct&) {
+    return fake_3d_models();
+}
+
 }  // namespace arm
 }  // namespace sdktests
 }  // namespace viam

src/viam/sdk/tests/mocks/mock_arm.hpp

@@ -7,6 +7,7 @@ namespace sdktests {
 namespace arm {
 
 sdk::Arm::KinematicsData fake_kinematics();
+std::map<std::string, common::v1::Mesh> fake_3d_models();
 
 class MockArm : public sdk::Arm {
    public:
@@ -29,7 +30,7 @@ class MockArm : public sdk::Arm {
     sdk::ProtoStruct do_command(const sdk::ProtoStruct& command) override;
     sdk::Arm::KinematicsData get_kinematics(const sdk::ProtoStruct&) override;
     std::vector<sdk::GeometryConfig> get_geometries(const sdk::ProtoStruct&) override;
-
+    std::map<std::string, common::v1::Mesh> get_3d_models(const sdk::ProtoStruct&) override;
     sdk::pose current_location;
     std::vector<double> joint_positions;
     std::vector<std::vector<double>> move_thru_positions;

src/viam/sdk/tests/test_arm.cpp

@@ -104,6 +104,26 @@ BOOST_AUTO_TEST_CASE(test_do_command) {
     });
 }
 
+BOOST_AUTO_TEST_CASE(test_get_3d_models) {
+    std::shared_ptr<MockArm> mock = MockArm::get_mock_arm();
+    client_to_mock_pipeline<Arm>(mock, [](Arm& client) {
+        const auto& models = client.get_3d_models();
+        const auto& expected = fake_3d_models();
+
+        // Compare keysets directly
+        std::set<std::string> model_keys;
+        std::set<std::string> expected_keys;
+        for (const auto& [key, _] : models) {
+            model_keys.insert(key);
+        }
+        for (const auto& [key, _] : expected) {
+            expected_keys.insert(key);
+        }
+        BOOST_CHECK_EQUAL_COLLECTIONS(
+            model_keys.begin(), model_keys.end(), expected_keys.begin(), expected_keys.end());
+    });
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 
 }  // namespace sdktests