summaryrefslogtreecommitdiffstats
path: root/CAN-binder/low-can-binding/can/can-message-set.hpp
blob: 9555d005abd87a665063042e9c0b34d25f7168c3 (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
/*
 * 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>

#include "can-message-definition.hpp"

class can_signal_t;

/// @brief A parent wrapper for a particular set of CAN messages and associated
/// CAN buses(e.g. a vehicle or program).
class can_message_set_t
{
private:
	uint8_t index_; /// < A numerical ID for the message set, ideally the index in an array for fast lookup
	const std::string name_; /// < The name of the message set.
	std::vector<std::shared_ptr<can_message_definition_t> > can_messages_definition_; ///< Vector holding all message definition handled by this message set.

public:
	can_message_set_t(
			uint8_t index,
			const std::string& name,
			std::vector<std::shared_ptr<can_message_definition_t> > can_messages_definition);

	std::vector<std::shared_ptr<can_message_definition_t> > get_can_message_definition();
	std::vector<std::shared_ptr<can_signal_t> > get_can_signals() const;
};