diff options
Diffstat (limited to 'src/utils/openxc-utils.cpp')
| -rw-r--r-- | src/utils/openxc-utils.cpp | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/src/utils/openxc-utils.cpp b/src/utils/openxc-utils.cpp index 34fe7f0..8449acc 100644 --- a/src/utils/openxc-utils.cpp +++ b/src/utils/openxc-utils.cpp @@ -20,6 +20,18 @@ #include "../configuration.hpp" + +/** + * @brief Build a specific VehicleMessage containing a DiagnosticResponse. + * + * @param[in] request - Original request use to retrieve decoder and callback + * @param[in] response - Response to the request that will be decoded if decoder set + * and put into the DiagnosticResponse of the VehicleMessage. + * @param[in] parsed_value - raw parsed value of the payload from CAN message + * + * @return a vehicle message including simple message that will be convert into + * a JSON object before being pushed to the subscribers + */ openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value) { openxc_VehicleMessage message; @@ -74,6 +86,14 @@ openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, return message; } +/** + * @brief Build a specific VehicleMessage containing a SimpleMessage. + * + * @param[in] message - simple message to include into openxc_VehicleMessage + * + * @return a vehicle message including simple message that will be convert into + * a JSON object before being pushed to the subscribers + */ openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message) { openxc_VehicleMessage v; @@ -88,6 +108,17 @@ openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message) return v; } +/** + * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField + * + * @param[in] name - const string reference name to assign to the created SimpleMessage + * this will set has_name member to true and assign name to the name member. Maximum size for name is + * set to 100 char. + * @param[in] value - const reference with DynamicField to assign to SimpleMessage + * value. + * + * @return an openxc_SimpleMessage struct initialized with name and value provided. + */ openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value) { openxc_SimpleMessage s; @@ -100,6 +131,14 @@ openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_D return s; } +/** + * @brief Build an openxc_DynamicField with a string value + * + * @param[in] value - const string reference value to assign to builded + * openxc_DynamicField. + * + * @return openxc_DynamicField initialized with a string value. + */ openxc_DynamicField build_DynamicField(const std::string& value) { openxc_DynamicField d; @@ -114,6 +153,15 @@ openxc_DynamicField build_DynamicField(const std::string& value) return d; } +/** + * @fn openxc_DynamicField build_DynamicField(double value); + * + * @brief Build an openxc_DynamicField with a double value + * + * @param[in] value - double value to assign to builded openxc_DynamicField. + * + * @return openxc_DynamicField initialized with a double value. + */ openxc_DynamicField build_DynamicField(double value) { openxc_DynamicField d; @@ -128,6 +176,13 @@ openxc_DynamicField build_DynamicField(double value) return d; } +/** + * @brief Build an openxc_DynamicField with a boolean value + * + * @param[in] value - boolean value to assign to builded openxc_DynamicField. + * + * @return openxc_DynamicField initialized with a boolean value. + */ openxc_DynamicField build_DynamicField(bool value) { openxc_DynamicField d; @@ -142,6 +197,16 @@ openxc_DynamicField build_DynamicField(bool value) return d; } +/** + * @brief Extract the simple message value from an openxc_VehicleMessage + * and return it. If there isn't SimpleMessage in the VehicleMessage then + * returned value will be a SimpleMessage with all field set at false. + * DynamicField from SimpleMessage will be boolean DynamicField set to false too. + * + * @param[in] v_msg - const reference to openxc_VehicleMessage + * + * @return A simpleMessage from the provided VehicleMessage. + */ openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg) { if (v_msg.has_simple_message) @@ -151,6 +216,13 @@ openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg) return s_msg; } +/** + * @brief Make a JSON object from a DynamicField + * + * @param[in] field - openxc_DynamicField struct to convert into + * a json object. + * @param[out] value - pointer to the object to set up. + */ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value) { if(field.has_numeric_value) @@ -161,6 +233,16 @@ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value) json_object_object_add(value, "value", json_object_new_string(field.string_value)); } +/** + * @brief Make a JSON object from a SimpleMessage + * + * @param[in] s_msg - const reference to an openxc_SimpleMessage + * struct to convert into a json object. + * @param[out] json - pointer with the DynamicField converted into json object + * + * @return True if SimpleMessage has been transformed into json object + * and false if not. In such case, a json object is returned { "error": "error msg"} + */ bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json) { if(s_msg.has_name) |