New constructor j1939 message definition

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

diff --git a/low-can-binding/can/can-message-definition.hpp b/low-can-binding/can/can-message-definition.hpp
index 98cb2c5..03c2fbe 100644 (file)
--- a/low-can-binding/can/can-message-definition.hpp
+++ b/low-can-binding/can/can-message-definition.hpp
@@ -28,30 +28,64 @@
 #include <vector>
 #include <memory>
 
-#include "can-bus-dev.hpp"
-#include "can-message.hpp"
+#include "can-signals.hpp"
+#include "message/can-message.hpp"
+#include "can-message-set.hpp"
 #include "../utils/timer.hpp"
 
+class can_message_set_t;
+
+/// @brief The definition of a CAN message. This includes a lot of metadata, so
+///  to save memory this class gets the can_signal_t object related to a CAN message.
 class can_message_definition_t
 {
 private:
-       std::uint8_t message_set_id_;
-       std::string bus_; /*!< bus_ - Address of CAN bus device. */
-       uint32_t id_; /*!< id_ - The ID of the message.*/
-       can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
-       frequency_clock_t frequency_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
-                                                        *      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.
-                                                                                 *     This is required for the forceSendChanged functionality, as the stack
-                                                                                 *     needs to compare an incoming CAN message with the previous frame.*/
-       
+       can_message_set_t* parent_; ///< parent_ - Pointer to the CAN message set holding this CAN message definition */
+       std::string bus_; ///< bus_ - Address of CAN bus device. */
+       uint32_t id_; ///< id_ - The ID of the message.*/
+       std::string name_; ///< name_ - J1939 PGN name
+       uint32_t length_; ///< length_ - Message data length in bytes. For J1939 message, this is the expected data size
+       bool is_fd_; /*!< uses_fd_ - Flags to enable an FD CAN message communication*/
+       can_message_format_t format_; ///< format_ - the format of the message's ID.*/
+       frequency_clock_t frequency_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
+                                                       ///     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.
+                                                                               ///     This is required for the forceSendChanged functionality, as the stack
+                                                                               ///     needs to compare an incoming CAN message with the previous frame.*/
+       std::vector<std::shared_ptr<can_signal_t> > can_signals_; ///< can_signals_ - Vector holding can_signal_t object which share the same arbitration ID */
+
 public:
-       can_message_definition_t(std::uint8_t message_set_id, const std::string bus);
-       can_message_definition_t(std::uint8_t message_set_id, const std::string bus, uint32_t id, frequency_clock_t frequency_clock, bool force_send_changed);
-       can_message_definition_t(std::uint8_t message_set_id, const std::string bus, uint32_t id, can_message_format_t format, frequency_clock_t frequency_clock, bool force_send_changed);
+       //can_message_definition_t(const can_message_definition_t& b);
+       can_message_definition_t(const std::string bus);
+       can_message_definition_t(const std::string bus, uint32_t id, frequency_clock_t frequency_clock, bool force_send_changed);
+       can_message_definition_t(const std::string bus, uint32_t id, can_message_format_t format, frequency_clock_t frequency_clock, bool force_send_changed);
+       can_message_definition_t(const std::string bus,
+                                uint32_t id,
+                                bool is_fd,
+                                can_message_format_t format,
+                                frequency_clock_t frequency_clock,
+                                bool force_send_changed,
+                                const std::vector<std::shared_ptr<can_signal_t> >& can_signals);
+       can_message_definition_t(const std::string bus,
+                                uint32_t id,
+                                std::string name,
+                                uint32_t length,
+                                bool is_fd,
+                                can_message_format_t format,
+                                frequency_clock_t frequency_clock,
+                                bool force_send_changed,
+                                const std::vector<std::shared_ptr<can_signal_t> >& can_signals);
 
+       const std::string get_bus_name() const;
+       const std::string get_bus_device_name() const;
        uint32_t get_id() const;
+       bool is_fd() const;
+       bool is_j1939() const;
+       std::vector<std::shared_ptr<can_signal_t> >& get_can_signals();
+
+       void set_parent(can_message_set_t* parent);
+       void set_last_value(const message_t& cm);
 };