2 * Copyright (C) 2015, 2016, 2017, 2018, 2019 "IoT\.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
4 * Author "Loïc Collignon" <loic.collignon@iot.bzh>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
27 class message_definition_t;
28 class diagnostic_message_t;
30 typedef std::vector<std::shared_ptr<signal_t>> vect_ptr_signal_t;
31 typedef std::vector<std::shared_ptr<message_definition_t>> vect_ptr_msg_def_t;
32 typedef std::vector<std::shared_ptr<diagnostic_message_t>> vect_ptr_diag_msg_t;
34 /// @brief A parent wrapper for a particular set of CAN messages and diagnostic messages
35 /// (e.g. a vehicle or program).
39 uint8_t index_; /// < A numerical ID for the message set, ideally the index is in an array for fast lookup
40 const std::string name_; /// < The name of the message set.
41 vect_ptr_msg_def_t messages_definition_; ///< Vector holding all message definitions handled by the message set.
42 vect_ptr_diag_msg_t diagnostic_messages_; ///< Vector holding all diagnostics messages from JSON signals description file. First vector map to message set
47 const std::string& name,
48 const vect_ptr_msg_def_t& messages_definition,
49 const vect_ptr_diag_msg_t& diagnostic_messages);
51 int add_message_definition(std::shared_ptr<message_definition_t> msg_def);
52 int add_diagnostic_message(std::shared_ptr<diagnostic_message_t> diag_msg);
54 vect_ptr_msg_def_t& get_messages_definition();
55 vect_ptr_signal_t get_all_signals() const;
56 vect_ptr_diag_msg_t& get_diagnostic_messages();
58 uint8_t get_index() const;