Rename submodule path to app-templates as the repo

[apps/agl-service-can-low-level.git] / CAN-binder / low-can-binding / can / can-message.hpp

diff --git a/CAN-binder/low-can-binding/can/can-message.hpp b/CAN-binder/low-can-binding/can/can-message.hpp
index 910b3e9..b206ebd 100644 (file)
--- a/CAN-binder/low-can-binding/can/can-message.hpp
+++ b/CAN-binder/low-can-binding/can/can-message.hpp
@@ -31,33 +31,33 @@
  * @brief The ID format for a CAN message.
  */
 enum class can_message_format_t {
-       STANDARD, /*!< STANDARD - standard 11-bit CAN arbitration ID. */
-       EXTENDED, /*!< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
-       INVALID,    /*!< INVALID - INVALID code used at initialization to signify that it isn't usable'*/
+       STANDARD, ///< STANDARD - standard 11-bit CAN arbitration ID. */
+       EXTENDED, ///< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
+       INVALID,    ///< INVALID - INVALID code used at initialization to signify that it isn't usable'*/
 };
 
-/**
- * @class can_message_t
- *
- * @brief A compact representation of a single CAN message, meant to be used in in/out
- * buffers.
- */
+/// @class can_message_t
+///
+/// @brief A compact representation of a single CAN message, meant to be used in in/out
+/// buffers. It is a wrapper of a can_frame struct with some sugar around it for binding purposes.
 class can_message_t {
 private:
-       uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
-       uint32_t id_; /*!< id_ - The ID of the message. */
-       uint8_t length_; /*!< length_ - the length of the data array (max 8). */
-       can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
-       bool rtr_flag_; /*!< rtr_flag_ - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
-       uint8_t flags_; /*!< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
-       std::vector<uint8_t> data_; /*!< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
-       uint64_t timestamp_; /*!< timestamp_ - timestamp of the received message*/
+       uint8_t maxdlen_; ///< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
+       uint32_t id_; ///< id_ - The ID of the message. */
+       uint8_t length_; ///< length_ - the length of the data array (max 8). */
+       can_message_format_t format_; ///< format_ - the format of the message's ID.*/
+       bool rtr_flag_; ///< rtr_flag_ - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
+       uint8_t flags_; ///< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
+       std::vector<uint8_t> data_; ///< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
+       uint64_t timestamp_; ///< timestamp_ - timestamp of the received message*/
+       int sub_id_; ///< sub_id_ - Subscription index. */
 
 public:
        can_message_t();
-       can_message_t(uint8_t maxdlen, uint32_t id, uint8_t length, can_message_format_t format, bool rtr_flag_, uint8_t flags, std::vector<uint8_t> data, uint64_t timestamp);
+       can_message_t(uint8_t maxdlen, uint32_t id, uint8_t length, can_message_format_t format, bool rtr_flag_, uint8_t flags, std::vector<uint8_t>& data, uint64_t timestamp);
 
        uint32_t get_id() const;
+       int get_sub_id() const;
        bool get_rtr_flag_() const;
        can_message_format_t get_format() const;
        uint8_t get_flags() const;
@@ -66,6 +66,7 @@ public:
        uint8_t get_length() const;
        uint64_t get_timestamp() const;
 
+       void set_sub_id(int sub_id);
        void set_timestamp(uint64_t timestamp);
        void set_format(const can_message_format_t new_format);