CAN-binder/low-can-binding/binding/low-can-cb.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 <string>
  21 #include <cmath>
  22 #include <utility>
  23
  24 #include "../can/can-signals.hpp"
  25 #include "../diagnostic/diagnostic-message.hpp"
  26 #include "../utils/socketcan-bcm.hpp"
  27
  28 struct event_filter_t
  29 {
  30         float frequency;
  31         float min;
  32         float max;
  33         event_filter_t() : frequency{NAN}, min{NAN}, max{NAN} {}
  34 };
  35
  36 class low_can_subscription_t
  37 {
  38 private:
  39         int index_;
  40
  41         /// Signal part
  42         std::shared_ptr<can_signal_t> can_signal_;
  43         std::shared_ptr<active_diagnostic_request_t> active_diagnostic_request_;
  44
  45         /// Filtering part
  46         struct event_filter_t event_filter_;
  47
  48         utils::socketcan_bcm_t socket_;
  49 public:
  50         low_can_subscription_t();
  51         low_can_subscription_t(struct event_filter_t event_filter);
  52         low_can_subscription_t(struct event_filter_t event_filter, std::shared_ptr<active_diagnostic_request_t> active_diagnostic_request);
  53         low_can_subscription_t(const low_can_subscription_t& s) = delete;
  54         low_can_subscription_t(low_can_subscription_t&& s);
  55
  56         low_can_subscription_t& operator=(const low_can_subscription_t& s);
  57         explicit operator bool() const;
  58
  59         int get_index() const;
  60         const std::shared_ptr<can_signal_t> get_can_signal() const;
  61         const std::string get_name() const;
  62         float get_frequency() const;
  63         float get_min() const;
  64         float get_max() const;
  65         utils::socketcan_bcm_t& get_socket();
  66
  67         void set_frequency(float freq);
  68         void set_min(float min);
  69         void set_max(float max);
  70
  71         int create_rx_filter();
  72         int create_rx_filter(std::shared_ptr<can_signal_t> sig);
  73 };