diff options
author | Romain Forlot <romain.forlot@iot.bzh> | 2019-06-26 15:51:19 +0200 |
---|---|---|
committer | Romain Forlot <romain.forlot@iot.bzh> | 2019-06-26 18:04:58 +0200 |
commit | 2f60d294b3fa4e243fa67a738f9b82a0b428a7fc (patch) | |
tree | ed6b50772964ce360eb2a0ebeadac29a8fb9ed2c /low-can-binding/can/can-message-definition.hpp | |
parent | d2180abe18533be7cbe68971a6767e5c2a0ecf6d (diff) |
Rename some of the classes removing can- prefix
This commit renames files and classes :
- can_message_definition_t -> message_definition_t
- can_message_set_t -> message_set_t
- can_signals_t -> signals_t
This prepares the implementation of j1939 protocol.
Bug-AGL: SPEC-2386
Change-Id: Ie3ee4f25c236c861b92eb12a56fa03a5a9afffbb
Signed-off-by: Arthur Guyader <arthur.guyader@iot.bzh>
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'low-can-binding/can/can-message-definition.hpp')
-rw-r--r-- | low-can-binding/can/can-message-definition.hpp | 91 |
1 files changed, 0 insertions, 91 deletions
diff --git a/low-can-binding/can/can-message-definition.hpp b/low-can-binding/can/can-message-definition.hpp deleted file mode 100644 index 03c2fbed..00000000 --- a/low-can-binding/can/can-message-definition.hpp +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright (C) 2015, 2016 "IoT.bzh" - * Author "Romain Forlot" <romain.forlot@iot.bzh> - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** - * @class can_message_definition_t - * - * @brief The definition of a CAN message. This includes a lot of metadata, so - * to save memory this struct should not be used for storing incoming and - * outgoing CAN messages. - */ - -#pragma once - -#include <vector> -#include <memory> - -#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: - 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(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); -}; |