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 #include <vector>
  24 #include <memory>
  25
  26 class can_signal_t;
  27 class can_message_definition_t;
  28 class diagnostic_message_t;
  29
  30 /// @brief A parent wrapper for a particular set of CAN messages and diagnostic messages
  31 /// (e.g. a vehicle or program).
  32 class can_message_set_t
  33 {
  34 private:
  35         uint8_t index_; /// < A numerical ID for the message set, ideally the index in an array for fast lookup
  36         const std::string name_; /// < The name of the message set.
  37         std::vector<std::shared_ptr<can_message_definition_t> > can_messages_definition_; ///< Vector holding all message definition handled by this message set.
  38         std::vector<std::shared_ptr<diagnostic_message_t> > diagnostic_messages_; ///< Vector holding all diagnostics messages from JSON signals description file. First vector map to message set
  39
  40 public:
  41         can_message_set_t(
  42                         uint8_t index,
  43                         const std::string& name,
  44                         const std::vector<std::shared_ptr<can_message_definition_t> >& can_messages_definition,
  45                         const std::vector<std::shared_ptr<diagnostic_message_t> >& diagnostic_messages);
  46
  47         std::vector<std::shared_ptr<can_message_definition_t> >& get_can_message_definition();
  48         std::vector<std::shared_ptr<can_signal_t> > get_all_can_signals() const;
  49         std::vector<std::shared_ptr<diagnostic_message_t> >& get_diagnostic_messages();
  50 };