SDK: Add Topology::AsyncGetProperties

Co-Author: Dennis Klein <d.klein@gsi.de>

fairmq/sdk/commands/Commands.cxx

@@ -46,7 +46,7 @@ array<string, 2> resultNames =
     }
 };
 
-array<string, 18> typeNames =
+array<string, 21> typeNames =
 {
     {
         "CheckState",
@@ -57,6 +57,7 @@ array<string, 18> typeNames =
         "SubscribeToStateChange",
         "UnsubscribeFromStateChange",
         "StateChangeExitingReceived",
+        "GetProperties",
         "SetProperties",
 
         "CurrentState",
@@ -68,6 +69,7 @@ array<string, 18> typeNames =
         "StateChangeSubscription",
         "StateChangeUnsubscription",
         "StateChange",
+        "Properties",
         "PropertiesSet"
     }
 };
@@ -150,7 +152,7 @@ array<sdk::cmd::FBTransition, 12> mqTransitionToFBTransition =
     }
 };
 
-array<FBCmd, 19> typeToFBCmd =
+array<FBCmd, 21> typeToFBCmd =
 {
     {
         FBCmd::FBCmd_check_state,
@@ -161,6 +163,7 @@ array<FBCmd, 19> typeToFBCmd =
         FBCmd::FBCmd_subscribe_to_state_change,
         FBCmd::FBCmd_unsubscribe_from_state_change,
         FBCmd::FBCmd_state_change_exiting_received,
+        FBCmd::FBCmd_get_properties,
         FBCmd::FBCmd_set_properties,
         FBCmd::FBCmd_current_state,
         FBCmd::FBCmd_transition_status,
@@ -171,11 +174,12 @@ array<FBCmd, 19> typeToFBCmd =
         FBCmd::FBCmd_state_change_subscription,
         FBCmd::FBCmd_state_change_unsubscription,
         FBCmd::FBCmd_state_change,
+        FBCmd::FBCmd_properties,
         FBCmd::FBCmd_properties_set
     }
 };
 
-array<Type, 19> fbCmdToType =
+array<Type, 21> fbCmdToType =
 {
     {
         Type::check_state,
@@ -186,6 +190,7 @@ array<Type, 19> fbCmdToType =
         Type::subscribe_to_state_change,
         Type::unsubscribe_from_state_change,
         Type::state_change_exiting_received,
+        Type::get_properties,
         Type::set_properties,
         Type::current_state,
         Type::transition_status,
@@ -196,6 +201,7 @@ array<Type, 19> fbCmdToType =
         Type::state_change_subscription,
         Type::state_change_unsubscription,
         Type::state_change,
+        Type::properties,
         Type::properties_set
     }
 };
@@ -255,6 +261,14 @@ string Cmds::Serialize(const Format type) const
                 cmdBuilder = tools::make_unique<FBCommandBuilder>(fbb);
             }
             break;
+            case Type::get_properties: {
+                auto _cmd = static_cast<GetProperties&>(*cmd);
+                auto query = fbb.CreateString(_cmd.GetQuery());
+                cmdBuilder = tools::make_unique<FBCommandBuilder>(fbb);
+                cmdBuilder->add_request_id(_cmd.GetRequestId());
+                cmdBuilder->add_property_query(query);
+            }
+            break;
             case Type::set_properties: {
                 auto _cmd = static_cast<SetProperties&>(*cmd);
                 std::vector<flatbuffers::Offset<FBProperty>> propsVector;
@@ -343,6 +357,25 @@ string Cmds::Serialize(const Format type) const
                 cmdBuilder->add_current_state(GetFBState(_cmd.GetCurrentState()));
             }
             break;
+            case Type::properties: {
+                auto _cmd = static_cast<Properties&>(*cmd);
+                auto deviceId = fbb.CreateString(_cmd.GetDeviceId());
+
+                std::vector<flatbuffers::Offset<FBProperty>> propsVector;
+                for (const auto& e : _cmd.GetProps()) {
+                    auto key = fbb.CreateString(e.first);
+                    auto val = fbb.CreateString(e.second);
+                    auto prop = CreateFBProperty(fbb, key, val);
+                    propsVector.push_back(prop);
+                }
+                auto props = fbb.CreateVector(propsVector);
+                cmdBuilder = tools::make_unique<FBCommandBuilder>(fbb);
+                cmdBuilder->add_device_id(deviceId);
+                cmdBuilder->add_request_id(_cmd.GetRequestId());
+                cmdBuilder->add_result(GetFBResult(_cmd.GetResult()));
+                cmdBuilder->add_properties(props);
+            }
+            break;
             case Type::properties_set: {
                 auto _cmd = static_cast<PropertiesSet&>(*cmd);
                 auto deviceId = fbb.CreateString(_cmd.GetDeviceId());
@@ -428,6 +461,9 @@ void Cmds::Deserialize(const string& str, const Format type)
             case FBCmd_state_change_exiting_received:
                 fCmds.emplace_back(make<StateChangeExitingReceived>());
             break;
+            case FBCmd_get_properties:
+                fCmds.emplace_back(make<GetProperties>(cmdPtr.request_id(), cmdPtr.property_query()->str()));
+            break;
             case FBCmd_set_properties: {
                 std::vector<std::pair<std::string, std::string>> properties;
                 auto props = cmdPtr.properties();
@@ -463,6 +499,14 @@ void Cmds::Deserialize(const string& str, const Format type)
             case FBCmd_state_change:
                 fCmds.emplace_back(make<StateChange>(cmdPtr.device_id()->str(), cmdPtr.task_id(), GetMQState(cmdPtr.last_state()), GetMQState(cmdPtr.current_state())));
             break;
+            case FBCmd_properties: {
+                std::vector<std::pair<std::string, std::string>> properties;
+                auto props = cmdPtr.properties();
+                for (unsigned int j = 0; j < props->size(); ++j) {
+                    properties.emplace_back(props->Get(j)->key()->str(), props->Get(j)->value()->str());
+                }
+                fCmds.emplace_back(make<Properties>(cmdPtr.device_id()->str(), cmdPtr.request_id(), GetResult(cmdPtr.result()), properties));
+            } break;
             case FBCmd_properties_set:
                 fCmds.emplace_back(make<PropertiesSet>(cmdPtr.device_id()->str(), cmdPtr.request_id(), GetResult(cmdPtr.result())));
             break;

fairmq/sdk/commands/Commands.h

@@ -47,6 +47,7 @@ enum class Type : int
     subscribe_to_state_change,     // args: { }
     unsubscribe_from_state_change, // args: { }
     state_change_exiting_received, // args: { }
+    get_properties,                // args: { request_id, property_query }
     set_properties,                // args: { request_id, properties }
 
     current_state,                 // args: { device_id, current_state }
@@ -58,6 +59,7 @@ enum class Type : int
     state_change_subscription,     // args: { device_id, Result }
     state_change_unsubscription,   // args: { device_id, Result }
     state_change,                  // args: { device_id, task_id, last_state, current_state }
+    properties,                    // args: { device_id, request_id, Result, properties }
     properties_set                 // args: { device_id, request_id, Result }
 };
 
@@ -121,6 +123,24 @@ struct StateChangeExitingReceived : Cmd
     explicit StateChangeExitingReceived() : Cmd(Type::state_change_exiting_received) {}
 };
 
+struct GetProperties : Cmd
+{
+    GetProperties(std::size_t request_id, std::string query)
+        : Cmd(Type::get_properties)
+        , fRequestId(request_id)
+        , fQuery(std::move(query))
+    {}
+
+    auto GetRequestId() const -> std::size_t { return fRequestId; }
+    auto SetRequestId(std::size_t requestId) -> void { fRequestId = requestId; }
+    auto GetQuery() const -> std::string { return fQuery; }
+    auto SetQuery(std::string query) -> void { fQuery = std::move(query); }
+
+  private:
+    std::size_t fRequestId;
+    std::string fQuery;
+};
+
 struct SetProperties : Cmd
 {
     SetProperties(std::size_t request_id, std::vector<std::pair<std::string, std::string>> properties)
@@ -309,6 +329,32 @@ struct StateChange : Cmd
     fair::mq::State fCurrentState;
 };
 
+struct Properties : Cmd
+{
+    Properties(std::string deviceId, std::size_t requestId, const Result result, std::vector<std::pair<std::string, std::string>> properties)
+        : Cmd(Type::properties)
+        , fDeviceId(std::move(deviceId))
+        , fRequestId(requestId)
+        , fResult(result)
+        , fProperties(std::move(properties))
+    {}
+
+    auto GetDeviceId() const -> std::string { return fDeviceId; }
+    auto SetDeviceId(std::string deviceId) -> void { fDeviceId = std::move(deviceId); }
+    auto GetRequestId() const -> std::size_t { return fRequestId; }
+    auto SetRequestId(std::size_t requestId) -> void { fRequestId = requestId; }
+    auto GetResult() const -> Result { return fResult; }
+    auto SetResult(Result result) -> void { fResult = result; }
+    auto GetProps() const -> std::vector<std::pair<std::string, std::string>> { return fProperties; }
+    auto SetProps(std::vector<std::pair<std::string, std::string>> properties) -> void { fProperties = std::move(properties); }
+
+  private:
+    std::string fDeviceId;
+    std::size_t fRequestId;
+    Result fResult;
+    std::vector<std::pair<std::string, std::string>> fProperties;
+};
+
 struct PropertiesSet : Cmd {
     PropertiesSet(std::string deviceId, std::size_t requestId, Result result)
         : Cmd(Type::properties_set)

fairmq/sdk/commands/CommandsFormat.fbs

@@ -52,7 +52,8 @@ enum FBCmd:byte {
     subscribe_to_state_change,     // args: { }
     unsubscribe_from_state_change, // args: { }
     state_change_exiting_received, // args: { }
-    set_properties,                // args: { key, value }
+    get_properties,                // args: { request_id, property_query }
+    set_properties,                // args: { request_id, properties }
 
     current_state,                 // args: { device_id, current_state }
     transition_status,             // args: { device_id, Result, transition }
@@ -63,6 +64,7 @@ enum FBCmd:byte {
     state_change_subscription,     // args: { device_id, Result }
     state_change_unsubscription,   // args: { device_id, Result }
     state_change,                  // args: { device_id, task_id, last_state, current_state }
+    properties,                    // args: { device_id, request_id, Result, properties }
     properties_set                 // args: { device_id, request_id, Result }
 }
 
@@ -79,6 +81,7 @@ table FBCommand {
     current_state:FBState;
     debug:string;
     properties:[FBProperty];
+    property_query:string;
 }
 
 table FBCommands {