modbusSMA::MBConnectionIP Class Reference
Class for an IP based modbus connection. More...
#include <MBConnectionIP.hpp>
Inheritance diagram for modbusSMA::MBConnectionIP:
Collaboration diagram for modbusSMA::MBConnectionIP:
Public Member Functions | |
| MBConnectionIP (std::string _ip, uint32_t _port) | |
| This constructor only initializes the IP and the port. | |
| MBConnectionIP (MBConnectionIP const &)=delete | |
| void | operator= (MBConnectionIP const &)=delete |
| std::string | getIP () const |
| Returns the IP address used. More... | |
| uint32_t | getPort () const |
| Returns the Port used. More... | |
| ConnectionType | type () override |
| Returns the modbus connection type. More... | |
| std::string | description () override |
| Textual description of the connection. More... | |
 Public Member Functions inherited from modbusSMA::MBConnectionBase | |
| virtual | ~MBConnectionBase () |
| Disconnects the modbus connection if neccessary. | |
| MBConnectionBase (MBConnectionBase const &)=delete | |
| void | operator= (MBConnectionBase const &)=delete |
| ErrorCode | connect () |
| Creates the modbus connection based on the backend context implementation. More... | |
| ErrorCode | setSlaveID (int _id) |
| Sets the slave/uinit ID of the modbus connection. More... | |
| void | disconnect () |
| Disconnects an active modbus connnection (if present, else does nothing). | |
| bool | isConnected () const |
| Returns whether a valid conection exists. More... | |
| std::vector< uint16_t > | readRegisters (uint32_t _reg, uint32_t _num) |
| read _num registers from the device More... | |
| modbus_t * | getConnection () |
| Returns the raw connection. More... | |
Protected Member Functions | |
| modbus_t * | createModbusContext () override |
| Creates the modbus IP context. More... | |
Detailed Description
Class for an IP based modbus connection.
Definition at line 29 of file MBConnectionIP.hpp.
Member Function Documentation
◆ createModbusContext()
|
overrideprotectedvirtual |
Creates the modbus IP context.
Returns nullptr on error.
Implements modbusSMA::MBConnectionBase.
Definition at line 34 of file MBConnectionIP.cpp.
◆ description()
|
overridevirtual |
Textual description of the connection.
Implements modbusSMA::MBConnectionBase.
Definition at line 47 of file MBConnectionIP.cpp.
◆ getIP()
|
inline |
Returns the IP address used.
Definition at line 44 of file MBConnectionIP.hpp.
◆ getPort()
|
inline |
Returns the Port used.
Definition at line 45 of file MBConnectionIP.hpp.
◆ type()
|
inlineoverridevirtual |
Returns the modbus connection type.
Implements modbusSMA::MBConnectionBase.
Definition at line 47 of file MBConnectionIP.hpp.
The documentation for this class was generated from the following files:
- lib/MBConnectionIP.hpp
- lib/MBConnectionIP.cpp
