low-can-binding/can/can-message-set.hpp

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loïc Collignon" <loic.collignon@iot.bzh>
   5  *
   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
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 #pragma once
  20
  21 #include <cstdint>
  22 #include <string>
  23
  24 /// @brief A parent wrapper for a particular set of CAN messages and associated
  25 /// CAN buses(e.g. a vehicle or program).
  26 class can_message_set_t
  27 {
  28 private:
  29         uint8_t index_; /// < A numerical ID for the message set, ideally the index in an array for fast lookup
  30         const std::string name_; /// < The name of the message set.
  31         uint8_t can_bus_count_; /// < The number of CAN buses defined for this message set.
  32         uint16_t can_message_count_; /// < The number of CAN messages (across all buses) defined for this message set.
  33         uint16_t can_signal_count_; /// < The number of CAN signals (across all messages) defined for this message set.
  34         uint16_t can_command_count_; /// < The number of CanCommmands defined for this message set.
  35         uint16_t obd2_signal_count_; /// < The number of obd2 signals defined for this message set.
  36
  37 public:
  38         can_message_set_t(
  39                         uint8_t index,
  40                         const std::string& name,
  41                         uint8_t can_bus_count,
  42                         short unsigned int can_message_count,
  43                         short unsigned int can_signal_count,
  44                         short unsigned int can_command_count,
  45                         short unsigned int obd2_signal_count);
  46
  47 };