diff options
Diffstat (limited to 'src/openxc-utils.hpp')
-rw-r--r-- | src/openxc-utils.hpp | 71 |
1 files changed, 66 insertions, 5 deletions
diff --git a/src/openxc-utils.hpp b/src/openxc-utils.hpp index ad2d1c5..b7fa788 100644 --- a/src/openxc-utils.hpp +++ b/src/openxc-utils.hpp @@ -25,6 +25,8 @@ #include "openxc.pb.h" /** + * @fn openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message); + * * @brief Build a specific VehicleMessage containing a SimpleMessage. * * @param[in] openxc_DynamicField_Type type - The type of message to build @@ -36,30 +38,89 @@ openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message); /** + * @fn openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value); + * * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField + * + * @param[in] std::string 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] openxc_DynamicField 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); + /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @fn openxc_DynamicField build_DynamicField(const std::string& value); + * + * @brief Build an openxc_DynamicField with a string value + * + * @param std::string 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); /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @fn openxc_DynamicField build_DynamicField(double value); + * + * @brief Build an openxc_DynamicField with a double value + * + * @param double value - double value to assign to builded openxc_DynamicField. + * + * @return openxc_DynamicField initialized with a double value. */ openxc_DynamicField build_DynamicField(double value); /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @fn openxc_DynamicField build_DynamicField(bool value); + * + * @brief Build an openxc_DynamicField with a boolean value + * + * @param bool value - boolean value to assign to builded openxc_DynamicField. + * + * @return openxc_DynamicField initialized with a boolean value. */ openxc_DynamicField build_DynamicField(bool value); +/** + * @fn void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value); + * + * @brief Make a JSON object from a DynamicField + * + * @param[in] openxc_DynamicField field - openxc_DynamicField struct to convert into + * a json object. + * @param[out] json_object pointer with the DynamicField converted + */ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value); /** + * @fn openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg); + * * @brief Extract the simple message value from an openxc_VehicleMessage - * and return it, or null if there isn't. + * 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] openxc_VehicleMessage - const reference to openxc_VehicleMessage + * + * @return openxc_SimpleMessage - SimpleMessage from the provided VehicleMessage. */ openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg); -json_object* jsonify_simple(const openxc_SimpleMessage& s_msg);
\ No newline at end of file +/** + * @fn json_object* jsonify_simple(const openxc_SimpleMessage& s_msg); + * + * @brief Make a JSON object from a SimpleMessage + * + * @param[in] openxc_SimpleMessage s_msg - const reference to an openxc_SimpleMessage + * struct to convert into a json object. + * @param[out] json_object pointer with the DynamicField converted + * + * @return boolean value - 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);
\ No newline at end of file |