Change FrequencyClock struct to class and rename it.

[apps/agl-service-can-low-level.git] / src / can / can-message.hpp

diff --git a/src/can/can-message.hpp b/src/can/can-message.hpp
index 0e46cc8..629fb93 100644 (file)
--- a/src/can/can-message.hpp
+++ b/src/can/can-message.hpp
@@ -29,10 +29,10 @@
 class can_bus_dev_t;
 
 /**
- * @enum can_message_format
+ * @enum can_message_format_t
  * @brief The ID format for a CAN message.
  */
-enum class can_message_format {
+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. */
        ERROR,    /*!< ERROR - ERROR code used at initialization to signify that it isn't usable'*/
@@ -45,32 +45,32 @@ enum class can_message_format {
  * 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 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.*/
-
-               uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
-
-       public:
-               can_message_t();
-
-               uint32_t get_id() const;
-               bool get_rtr_flag_() const;
-               int 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 new_format);
-
-               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();
+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.*/
+
+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);
+
+       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);
+
+       bool is_correct_to_send();
+
+static can_message_t convert_from_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
+       canfd_frame convert_to_canfd_frame();
 };
 
 /**
@@ -85,8 +85,8 @@ class can_message_definition_t
        private:
        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 format_; /*!< format_ - the format of the message's ID.*/
-       FrequencyClock clock_; /*!<  clock_ - an optional frequency clock to control the output of this
+       can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
+       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;
 };