Again change enum name and add "_t" suffix to get

[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 6736a9b..bdba07b 100644 (file)
--- a/src/can/can-message.hpp
+++ b/src/can/can-message.hpp
@@ -22,16 +22,17 @@
 #include <cstdint>
 #include <linux/can.h>
 
-#include "can/can-bus.hpp"
 #include "utils/timer.hpp"
 
 #define CAN_MESSAGE_SIZE 8
 
+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'*/
@@ -49,7 +50,7 @@ class can_message_t {
                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.*/
+               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.*/
 
                uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
@@ -59,12 +60,12 @@ class can_message_t {
 
                uint32_t get_id() const;
                bool get_rtr_flag_() const;
-               int get_format() 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 new_format);
+               void set_format(const can_message_format_t new_format);
 
                bool is_correct_to_send();
 
@@ -84,10 +85,10 @@ 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.*/
+       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
-                          *      message, if sent raw, or simply to mark the max frequency for custom
-                          *      handlers to retrieve.*/
+                                                       *      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
                                                         *      message if it has changed when using raw passthrough.*/
        std::vector<uint8_t> last_value_; /*!< last_value_ - The last received value of the message. Defaults to undefined.
@@ -124,7 +125,7 @@ class can_message_set_t
  *
  * Returns a pointer to an array of all configurations.
  */
-CanMessageSet* getMessageSets();
+can_message_set_t* getMessageSets();
 
 /** Public: Return the length of the array returned by getMessageSets() */
 int getMessageSetCount();
@@ -132,7 +133,7 @@ int getMessageSetCount();
 /* Public: Return an array of all CAN messages to be processed in the active
  * configuration.
  */
-CanMessageDefinition* getMessages();
+can_message_definition_t* getMessages();
 
 /* Public: Return the length of the array returned by getMessages(). */
 int getMessageCount();
\ No newline at end of file