summaryrefslogtreecommitdiffstats
path: root/low-can-binding/can/message-set.hpp
blob: eab4ed69faf9a31fcfc3a25a481ba39301d2f25b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
 * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
 * Author "Romain Forlot" <romain.forlot@iot.bzh>
 * Author "Loïc Collignon" <loic.collignon@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.
 */

#pragma once

#include <cstdint>
#include <string>
#include <vector>
#include <memory>

class signal_t;
class message_definition_t;
class diagnostic_message_t;

typedef std::vector<std::shared_ptr<signal_t>> vect_ptr_signal_t;
typedef std::vector<std::shared_ptr<diagnostic_message_t>> vect_ptr_diag_msg_t;
typedef std::vector<std::shared_ptr<message_definition_t>> vect_ptr_msg_def_t;

/// @brief A parent wrapper for a particular set of CAN messages and diagnostic messages
/// (e.g. a vehicle or program).
class message_set_t
{
private:
	uint8_t index_; /// < A numerical ID for the message set, ideally the index is in an array for fast lookup
	const std::string name_; /// < The name of the message set.
	std::vector<std::shared_ptr<message_definition_t> > messages_definition_; ///< Vector holding all message definitions handled by the message set.
	vect_ptr_diag_msg_t diagnostic_messages_; ///< Vector holding all diagnostics messages from JSON signals description file. First vector map to message set

public:
	message_set_t(
			uint8_t index,
			const std::string& name,
			const std::vector<std::shared_ptr<message_definition_t> >& messages_definition,
			const vect_ptr_diag_msg_t& diagnostic_messages);

	int add_message_definition(std::shared_ptr<message_definition_t> msg_def);
	int add_diagnostic_message(std::shared_ptr<diagnostic_message_t> diag_msg);

	vect_ptr_msg_def_t& get_messages_definition();
	vect_ptr_signal_t get_all_signals() const;
	vect_ptr_diag_msg_t& get_diagnostic_messages();

	uint8_t get_index() const;
};