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

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <vector>
  21 #include <string>
  22 #include <cstdint>
  23 #include <iostream>
  24 #include <memory>
  25 #include <linux/can.h>
  26 #include <linux/can/bcm.h>
  27 #include "../../utils/timer.hpp"
  28
  29 #define CAN_MESSAGE_SIZE 8
  30
  31 #define MAX_BCM_CAN_FRAMES 257
  32
  33
  34 /**
  35  * @enum message_format_t
  36  * @brief The ID format for a CAN message.
  37  */
  38 enum class message_format_t {
  39         STANDARD, ///< STANDARD - standard 11-bit CAN arbitration ID. */
  40         EXTENDED, ///< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
  41         J1939,    ///< J1939    - Format for j1939 messages
  42         INVALID,  ///< INVALID  - INVALID code used at initialization to signify that it isn't usable'*/
  43 };
  44
  45
  46 /// @class message_t
  47 ///
  48 /// @brief A compact representation of a single CAN message, meant to be used in in/out
  49 /// buffers. It is a wrapper of a can_frame struct with some sugar around it for binding purposes.
  50 class message_t {
  51 protected:
  52         uint32_t maxdlen_; ///< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
  53         uint32_t length_; ///< length_ - the length of the data array. */
  54         message_format_t format_; ///< format_ - the format of the message's ID.*/
  55         std::vector<uint8_t> data_; ///< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
  56         uint64_t timestamp_; ///< timestamp_ - timestamp of the received message*/
  57         int sub_id_; ///< sub_id_ - Subscription index. */
  58         uint32_t flags_; ///< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
  59
  60 public:
  61         message_t();
  62         message_t(uint32_t maxdlen, uint32_t length, message_format_t format, std::vector<uint8_t>& data, uint64_t timestamp, uint32_t flags);
  63         virtual ~message_t() = default;
  64
  65         int get_sub_id() const;
  66         const uint8_t* get_data() const;
  67         const std::vector<uint8_t> get_data_vector() const;
  68         const std::vector<uint8_t> get_data_vector(int start,int end) const;
  69         uint32_t get_length() const;
  70         uint64_t get_timestamp() const;
  71
  72         void set_data(std::vector<uint8_t> &data);
  73         void set_sub_id(int sub_id);
  74         void set_timestamp(uint64_t timestamp);
  75         message_format_t get_msg_format();
  76         virtual bool is_set() = 0;
  77         virtual std::string get_debug_message() = 0;
  78         virtual uint32_t get_id() const = 0;
  79         uint32_t get_flags();
  80         void set_flags(uint32_t flags);
  81         uint32_t get_maxdlen();
  82         void set_maxdlen(uint32_t maxdlen);
  83
  84
  85 };