Change FrequencyClock struct to class and rename it.
[apps/agl-service-can-low-level.git] / src / can / can-message.hpp
index bdba07b..629fb93 100644 (file)
@@ -45,32 +45,32 @@ enum class can_message_format_t {
  * buffers.
  */
 class can_message_t {
-       private:
-               uint32_t id_; /*!< id_ - The ID of the message. */
-               bool rtr_flag_; /*!< rtr_flag_ - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
-               uint8_t length_; /*!< length_ - the length of the data array (max 8). */
-               uint8_t flags_; /*!< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
-               can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
-               std::vector<uint8_t> data_; /*!< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
+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.*/
 
-               uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
+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);
 
-       public:
-               can_message_t();
-
-               uint32_t get_id() const;
-               bool get_rtr_flag_() const;
-               can_message_format_t get_format() const;
-               uint8_t get_flags() const;
-               const uint8_t* get_data() const;
-               uint8_t get_length() const;
+       uint32_t get_id() const;
+       bool get_rtr_flag_() const;
+       can_message_format_t get_format() const;
+       uint8_t get_flags() const;
+       const uint8_t* get_data() const;
+       uint8_t get_length() const;
 
-               void set_format(const can_message_format_t new_format);
+       void set_format(const can_message_format_t new_format);
 
-               bool is_correct_to_send();
+       bool is_correct_to_send();
 
-    static can_message_t convert_to_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
-               canfd_frame convert_to_canfd_frame();
+static can_message_t convert_from_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
+       canfd_frame convert_to_canfd_frame();
 };
 
 /**
@@ -86,7 +86,7 @@ class can_message_definition_t
        can_bus_dev_t& bus_; /*!< bus_ - A pointer to the bus this message is on. */
        uint32_t id_; /*!< id_ - The ID of the message.*/
        can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
-       FrequencyClock clock_; /*!<  clock_ - an optional frequency clock to control the output of this
+       frequency_clock_t clock_; /*!<  clock_ - an optional frequency clock to control the output of this
                                                        *      message, if sent raw, or simply to mark the max frequency for custom
                                                        *      handlers to retrieve.*/
        bool force_send_changed_; /*!< force_send_changed_ - If true, regardless of the frequency, it will send CAN
@@ -96,7 +96,7 @@ class can_message_definition_t
                                                                                  *     needs to compare an incoming CAN message with the previous frame.*/
        
        public:
-         can_message_definition_t();
+         can_message_definition_t(can_bus_dev_t& cbd);
                uint32_t get_id() const;
 };