5735b406
 Peter M. Groen
Revert "Setting u...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/****************************************************************************
* Copyright (c) 2022 Priva B.V.
****************************************************************************/
#pragma once
// Flexblox
#include "IModbusAdapter.h"
#include "ModbusAdapter.h"
// std
#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>
/// Easy replacement of template construction
using AdapterList = std::vector<std::shared_ptr<IModbusAdapter>>;
/*!
* \brief The ModbusConnections class conatins a list of all modbus connections, Serial and TCP.
* To access a specific connection, use its portname and / or endpoint to return it's interface.
*/
class ModbusConnections
{
public:
/*!
* \brief Default CTor
*/
explicit ModbusConnections();
/*!
* \brief Default DTor
*/
virtual ~ModbusConnections();
/*!
* \brief Create a modbus connection as described by the connection object.
* \param config - The connection object describing the connection in detail.
* \return The result of the creation.
* True = succesful.
* False = Failed.
*/
bool CreateConnection( const ConnectionConfig &config );
/*!
* \brief Remove the connection described by its portname and/or endpoint.
* \param portName - The portname as its enum
* \param endpoint - combination of ip-address and portname in endpoint-format
* ( tcp://<ip_address>:<portNumber> )
* ( i.e. tcp://127.0.0.1:501 )
* \return
*/
bool DeleteConnection( const ConnectionPort portName, const std::string &endpoint = std::string() );
/*!
* \brief Give the number of registered serial and tcp-connections combined.
*/
int ConnectionCount();
/*!
* \brief Get the connection give by its parameters.
* \param portName - The portname by its enum
* \param endpoint - combination of ip-address and portname in endpoint-format
* ( tcp://<ip_address>:<portNumber> )
* ( i.e. tcp://127.0.0.1:501 )
* \return Valid Pointer to the Modbus Connection Interface. nullptr if the connection wasn't found.
*/
std::shared_ptr<IModbusAdapter> getConnection( const ConnectionPort portName, const std::string &endpoint = std::string() );
// Convenient functions
/*!
* \brief Get the connection given by its parameters. If applicable, ipaddress and portnumber will be used to create the endpoint.
* \param portName - The portname by its enum
* \param ipAddress - The ipaddress of the TCP-connection
* \param tcpPortNumber - The portnumber of the TCP-connection
* \return Valid Pointer to the Modbus Connection Interface. nullptr if the connection wasn't found.
*/
std::shared_ptr<IModbusAdapter> getConnection( const ConnectionPort portName, const std::string &ipAddress, int tcpPortNumber );
/*!
* \brief Returns a list of all registered connections by their interfaces. This is a mix of Serial and TCP-connections.
*/
AdapterList getConnections();
private:
/*!
* \brief Check if a connection already exist.
* \param portName - The portName by its enum
* \param endpoint - The endpoint this connection was registered with.
* \return A valid pointer to the Interface if the connection exist. If the connection is unknown, it will return a nullptr.
* shared_ptr can manifest themselves as booleans, so "!ptr" is sufficient to check.
*/
std::shared_ptr<IModbusAdapter> connectionExist( const ConnectionPort portName, const std::string &endpoint = std::string() );
/*!
* \brief Create the TCP endpoint based on the connections IP-address and portnumber
* \param ipAddress - The ipAddress as string.
* \param portNumber - The portnumber as integer.
* \return The endpoint in format : tcp://<ip_address>:<portNumber> i.e. tcp://127.0.0.1:501
*/
std::string createEndPoint( const std::string &ipAddress, int portNumber );
/*!
* \brief Create the TCP endpoint based on the connections IP-address and portnumber extracted from the connection configuration.
* \param config - The configuration object used to create the connection.
* \return The endpoint in format : tcp://<ip_address>:<portNumber> i.e. tcp://127.0.0.1:501
*/
std::string createEndPoint( const ConnectionConfig &config );
private:
std::mutex m_mapSerialMutex; ///< Mutex protecting the serialmap
std::mutex m_mapTcpMutex; ///< Mutex protecting the TCPmap
std::unordered_map<ConnectionPort, std::shared_ptr<IModbusAdapter>> m_mapSerial; ///< Unordered map holding the Modbus connections By PortName
std::unordered_map<std::string, std::shared_ptr<IModbusAdapter>> m_mapTcp; ///< Unordered map holding the Modbus connections By tcp://endpoint:port
};
|
