#include <SafeVisionaryControl.h>
Definition at line 34 of file SafeVisionaryControl.h.
◆ ProtocolType
The numbers used for the protocols are the port numbers.
Enumerator |
---|
INVALID_PROTOCOL | |
COLA_2 | |
Definition at line 38 of file SafeVisionaryControl.h.
◆ SafeVisionaryControl()
visionary::SafeVisionaryControl::SafeVisionaryControl |
( |
| ) |
|
◆ ~SafeVisionaryControl()
visionary::SafeVisionaryControl::~SafeVisionaryControl |
( |
| ) |
|
◆ close()
void visionary::SafeVisionaryControl::close |
( |
| ) |
|
Close a connection
Closes the control connection. It is allowed to call close of a connection that is not open. In this case this call is a no-op.
Definition at line 74 of file SafeVisionaryControl.cpp.
◆ getDeviceIdent()
std::string visionary::SafeVisionaryControl::getDeviceIdent |
( |
| ) |
|
Get device information by calling the "DeviceIdent" method on the device.
- Returns
- True if successful, false otherwise.
Definition at line 107 of file SafeVisionaryControl.cpp.
◆ login()
Login to the device.
- Parameters
-
[in] | userLevel | The user level to login as. |
[in] | password | Password for the selected user level. |
- Returns
- error code, 0 on success
Definition at line 97 of file SafeVisionaryControl.cpp.
◆ logout()
bool visionary::SafeVisionaryControl::logout |
( |
| ) |
|
Logout from the device.
- Returns
- True if logout was successful, false otherwise.
Definition at line 102 of file SafeVisionaryControl.cpp.
◆ open()
bool visionary::SafeVisionaryControl::open |
( |
const std::string & |
hostname, |
|
|
uint8_t |
sessionTimeout_s = kSessionTimeout_s |
|
) |
| |
Opens a connection to a SafeVisionary sensor
- Parameters
-
[in] | hostname | name or IP address of the Visionary sensor. |
[in] | sessionTimeout_s | timeout of session in seconds |
- Return values
-
true | The connection to the sensor successfully was established. |
false | The connection attempt failed; the sensor is either
- switched off or has a different IP address or name
- not available using for PCs network settings (different subnet)
|
Definition at line 39 of file SafeVisionaryControl.cpp.
◆ receiveCoLaCommand()
CoLaCommand visionary::SafeVisionaryControl::receiveCoLaCommand |
( |
| ) |
|
|
private |
◆ receiveCoLaResponse()
std::string visionary::SafeVisionaryControl::receiveCoLaResponse |
( |
| ) |
|
|
private |
◆ sendCommand()
Send a CoLaBCommand to the device and waits for the result.
- Parameters
-
- Returns
- The response.
Definition at line 122 of file SafeVisionaryControl.cpp.
◆ kSessionTimeout_s
const uint8_t visionary::SafeVisionaryControl::kSessionTimeout_s = 5u |
|
static |
◆ m_pAuthentication
std::unique_ptr<IAuthentication> visionary::SafeVisionaryControl::m_pAuthentication |
|
private |
◆ m_pControlSession
std::unique_ptr<ControlSession> visionary::SafeVisionaryControl::m_pControlSession |
|
private |
◆ m_pProtocolHandler
std::unique_ptr<IProtocolHandler> visionary::SafeVisionaryControl::m_pProtocolHandler |
|
private |
◆ m_pTransport
std::unique_ptr<TcpSocket> visionary::SafeVisionaryControl::m_pTransport |
|
private |
The documentation for this class was generated from the following files: