KaCanOpen
 All Classes Functions Variables Typedefs Enumerations Pages
transmit_pdo_mapping.h
1 /*
2  * Copyright (c) 2015-2016, Thomas Keh
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #pragma once
33 
34 #include <string>
35 #include <vector>
36 #include <chrono>
37 #include <unordered_map>
38 #include <thread>
39 #include <memory>
40 
41 #include "mapping.h"
42 #include "types.h"
43 #include "address.h"
44 
45 namespace kaco {
46 
47  // forward declarations
48  class Core;
49  class Entry;
50 
55 
56  public:
57 
67  TransmitPDOMapping(Core& core, const std::unordered_map<Address, Entry>& dictionary, const std::unordered_map<std::string, Address>& name_to_address, uint16_t cob_id_,
68  TransmissionType transmission_type_, std::chrono::milliseconds repeat_time_, const std::vector<Mapping>& mappings_);
69 
71  TransmitPDOMapping(const TransmitPDOMapping&) = delete;
72 
75 
78 
80  uint16_t cob_id;
81 
83  TransmissionType transmission_type;
84 
86  std::chrono::milliseconds repeat_time;
87 
89  std::vector<Mapping> mappings;
90 
93  std::unique_ptr<std::thread> transmitter;
94 
96  void send() const;
97 
98  private:
99 
101  void check_correctness() const;
102 
103  static const bool debug = false;
104 
105  Core& m_core;
106 
108  const std::unordered_map<Address, Entry>& m_dictionary;
109 
111  const std::unordered_map<std::string, Address>& m_name_to_address;
112 
113  };
114 
115 } // end namespace kaco
TransmissionType transmission_type
Transmission type.
std::chrono::milliseconds repeat_time
Send repeat time.
This class represents a mapping from one or more dictionary entries to one transmit PDO...
~TransmitPDOMapping()
Stops the transmitter thread if there is one.
std::unique_ptr< std::thread > transmitter
The transmitter thread.
void send() const
Sends the PDO.
This class implements the Core of KaCanOpen It communicates with the CAN driver, sends CAN messages a...
Definition: core.h:59
uint16_t cob_id
COB-ID of the PDO.
std::vector< Mapping > mappings
Mapped entries with offset (see Mapping class)
TransmitPDOMapping(Core &core, const std::unordered_map< Address, Entry > &dictionary, const std::unordered_map< std::string, Address > &name_to_address, uint16_t cob_id_, TransmissionType transmission_type_, std::chrono::milliseconds repeat_time_, const std::vector< Mapping > &mappings_)
Constructor.