Fix: declaration and implementation of needed methods

[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 af1f050..5d45b98 100644 (file)
--- a/src/can/can-message.hpp
+++ b/src/can/can-message.hpp
@@ -31,19 +31,11 @@
  * @enum CanMessageFormat
  * @brief The ID format for a CAN message.
  */
-enum CanMessageFormat {
+class enum CanMessageFormat {
        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'*/
 };
-typedef enum CanMessageFormat CanMessageFormat;
-
-/**
- * @class can_message_t
- *
- * @brief A compact representation of a single CAN message, meant to be used in in/out
- * buffers.
- */
 
 /*************************
  * old CanMessage struct *
@@ -56,16 +48,23 @@ struct CanMessage {
 };
 typedef struct CanMessage CanMessage;
 */
+
+/**
+ * @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 {
        private:
-               uint32_t id_; /*!< uint32_t id - The ID of the message. */
-               bool rtr_flag_; /*!< bool rtr_flag - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
-               uint8_t length_; /*!<  uint8_t length - the length of the data array (max 8). */
-               uint8_t flags_; /*!< unint8_t flags of a CAN FD frame. Needed if we catch FD frames.*/
-               CanMessageFormat format_; /*!< CanMessageFormat format - the format of the message's ID.*/
-               std::vector<uint8_t> data_; /*!< uint8_t data  - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
+               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.*/
+               CanMessageFormat 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_;
+               uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
 
        public:
                can_message_t();
@@ -77,17 +76,11 @@ class can_message_t {
                const uint8_t* get_data() const;
                uint8_t get_length() const;
 
-               void set_max_data_length(size_t nbytes);
-               void set_id_and_format(const uint32_t new_id);
                void set_format(const CanMessageFormat new_format);
-               void set_format(const uint32_t can_id);
-               void set_flags(const uint8_t flags);
-               void set_data(const __u8* new_data);
-               void set_length(const uint8_t new_length);
 
                bool is_correct_to_send();
 
-               void convert_from_canfd_frame(const std::pair<struct canfd_frame&, size_t>args);
+    static can_message_t convert_to_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
                canfd_frame convert_to_canfd_frame();
 };
 
@@ -129,7 +122,7 @@ class can_message_definition_t
                                                                                  *     needs to compare an incoming CAN message with the previous frame.*/
        
        public:
-               uint32_t get_id();
+               uint32_t get_id() const;
 };
 
 /**
@@ -153,16 +146,16 @@ class can_message_definition_t
 class can_message_set_t
 {
        private:
-               uint8_t index; /*!<index - A numerical ID for the message set, ideally the index in an array
+               uint8_t index_; /*!<index_ - A numerical ID for the message set, ideally the index in an array
                                                *       for fast lookup*/
-               const std::string name; /*!< name - The name of the message set.*/
-               uint8_t can_bus_count; /*!< busCount - The number of CAN buses defined for this message set.*/
-               unsigned short can_message_count; /*!< messageCount - The number of CAN messages (across all buses) defined for
+               const std::string name_; /*!< name_ - The name of the message set.*/
+               uint8_t can_bus_count_; /*!< can_bus_count_ - The number of CAN buses defined for this message set.*/
+               unsigned short can_message_count_; /*!< can_message_count_ - The number of CAN messages (across all buses) defined for
                                                                                *       this message set.*/
-               unsigned short can_signal_count; /*!< signalCount - The number of CAN signals (across all messages) defined for
+               unsigned short can_signal_count_; /*!< can_signal_count_ - The number of CAN signals (across all messages) defined for
                                                                        *       this message set.*/
-               unsigned short can_command_count; /*!< commandCount - The number of CanCommmands defined for this message set.*/
-               unsigned short obd2_signal_count; /*!< commandCount - The number of obd2 signals defined for this message set.*/
+               unsigned short can_command_count_; /*!< can_command_count_ - The number of CanCommmands defined for this message set.*/
+               unsigned short obd2_signal_count_; /*!< obd2_signal_count_ - The number of obd2 signals defined for this message set.*/
 };
 
 /** Public: Return the currently active CAN configuration. */