2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
19 * @class message_definition_t
21 * @brief The definition of a CAN message. This includes a lot of metadata, so
22 * to save memory this struct should not be used for storing incoming and
23 * outgoing CAN messages.
31 #include "signals.hpp"
32 #include "message-set.hpp"
33 #include "../utils/timer.hpp"
34 #include "message/message.hpp"
38 /// @brief The definition of a CAN message. This includes a lot of metadata, so
39 /// to save memory this class gets the signal_t object related to a CAN message.
40 class message_definition_t
43 std::shared_ptr<message_set_t> parent_; ///< parent_ - Pointer to the CAN message set holding this CAN message definition */
44 std::string bus_; ///< bus_ - Address of CAN bus device. */
45 uint32_t id_; ///< id_ - The ID or the PGN (if j1939) of the message.*/
46 std::string name_; ///< name_ - J1939 PGN name
47 uint32_t length_; ///< length_ - Message data length in bytes. For J1939 message, this is the expected data size
48 bool is_fd_; /*!< uses_fd_ - Flags to enable an FD CAN message communication*/
49 message_format_t format_; ///< format_ - the format of the message's ID.*/
50 frequency_clock_t frequency_clock_; ///< clock_ - an optional frequency clock to control the output of this
51 /// message, if sent raw, or simply to mark the max frequency for custom
52 /// handlers to retrieve.*/
53 bool force_send_changed_; ///< force_send_changed_ - If true, regardless of the frequency, it will send CAN
54 /// message if it has changed when using raw passthrough.*/
55 std::vector<uint8_t> last_value_; ///< last_value_ - The last received value of the message. Defaults to undefined.
56 /// This is required for the forceSendChanged functionality, as the stack
57 /// needs to compare an incoming CAN message with the previous frame.*/
58 std::vector<std::shared_ptr<signal_t> > signals_; ///< signals_ - Vector holding signal_t object which share the same arbitration ID */
61 //message_definition_t(const message_definition_t& b);
62 message_definition_t(const std::string bus);
63 message_definition_t(const std::string bus, uint32_t id, frequency_clock_t frequency_clock, bool force_send_changed);
64 message_definition_t(const std::string bus, uint32_t id, message_format_t format, frequency_clock_t frequency_clock, bool force_send_changed);
65 message_definition_t(const std::string bus,
68 message_format_t format,
69 frequency_clock_t frequency_clock,
70 bool force_send_changed,
71 const std::vector<std::shared_ptr<signal_t> >& signals);
72 message_definition_t(const std::string bus,
77 message_format_t format,
78 frequency_clock_t frequency_clock,
79 bool force_send_changed,
80 const std::vector<std::shared_ptr<signal_t> >& signals);
83 const std::string get_bus_name() const;
84 const std::string get_bus_device_name() const;
85 uint32_t get_id() const;
87 bool is_j1939() const;
88 std::vector<std::shared_ptr<signal_t>>& get_signals();
90 void set_parent(std::shared_ptr<message_set_t> parent);
91 void set_last_value(std::shared_ptr<message_t> m);