#include <VisionaryControl.h>
Definition at line 35 of file VisionaryControl.h.
◆ ProtocolType
The numbers used for the protocols are the port numbers.
| Enumerator |
|---|
| INVALID_PROTOCOL | |
| COLA_A | |
| COLA_B | |
| COLA_2 | |
Definition at line 39 of file VisionaryControl.h.
◆ VisionaryControl()
| visionary::VisionaryControl::VisionaryControl |
( |
| ) |
|
◆ ~VisionaryControl()
| visionary::VisionaryControl::~VisionaryControl |
( |
| ) |
|
◆ close()
| void visionary::VisionaryControl::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 88 of file VisionaryControl.cpp.
◆ getDataStreamConfig()
| bool visionary::VisionaryControl::getDataStreamConfig |
( |
| ) |
|
Tells the device that there is a streaming channel by invoking a method named GetBlobClientConfig.
- Returns
- True if successful, false otherwise.
Definition at line 162 of file VisionaryControl.cpp.
◆ getDeviceIdent()
| std::string visionary::VisionaryControl::getDeviceIdent |
( |
| ) |
|
Get device information by calling the "DeviceIdent" method on the device.
- Returns
- True if successful, false otherwise.
Definition at line 121 of file VisionaryControl.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 111 of file VisionaryControl.cpp.
◆ logout()
| bool visionary::VisionaryControl::logout |
( |
| ) |
|
Logout from the device.
- Returns
- True if logout was successful, false otherwise.
Definition at line 116 of file VisionaryControl.cpp.
◆ open()
Opens a connection to a Visionary sensor
- Parameters
-
| [in] | type | protocol type the sensor understands (CoLa-A, CoLa-B or CoLa-2). This information is found in the sensor documentation. |
| [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)
- the protocol type or the port did not match. Please check your sensor documentation.
|
Definition at line 39 of file VisionaryControl.cpp.
◆ receiveCoLaCommand()
| CoLaCommand visionary::VisionaryControl::receiveCoLaCommand |
( |
| ) |
|
|
private |
◆ receiveCoLaResponse()
| std::string visionary::VisionaryControl::receiveCoLaResponse |
( |
| ) |
|
|
private |
◆ sendCommand()
Send a CoLaBCommand to the device and waits for the result.
- Parameters
-
- Returns
- The response.
Definition at line 171 of file VisionaryControl.cpp.
◆ startAcquisition()
| bool visionary::VisionaryControl::startAcquisition |
( |
| ) |
|
Start streaming the data by calling the "PLAYSTART" method on the device. Works only when acquisition is stopped.
- Returns
- True if successful, false otherwise.
Definition at line 136 of file VisionaryControl.cpp.
◆ stepAcquisition()
| bool visionary::VisionaryControl::stepAcquisition |
( |
| ) |
|
Trigger a single image on the device. Works only when acquisition is stopped.
- Returns
- True if successful, false otherwise.
Definition at line 146 of file VisionaryControl.cpp.
◆ stopAcquisition()
| bool visionary::VisionaryControl::stopAcquisition |
( |
| ) |
|
Stops the data stream. Works always, also when acquisition is already stopped before.
Definition at line 154 of file VisionaryControl.cpp.
◆ kSessionTimeout_s
| const uint8_t visionary::VisionaryControl::kSessionTimeout_s = 5u |
|
static |
◆ m_pAuthentication
| std::unique_ptr<IAuthentication> visionary::VisionaryControl::m_pAuthentication |
|
private |
◆ m_pControlSession
| std::unique_ptr<ControlSession> visionary::VisionaryControl::m_pControlSession |
|
private |
◆ m_pProtocolHandler
| std::unique_ptr<IProtocolHandler> visionary::VisionaryControl::m_pProtocolHandler |
|
private |
◆ m_pTransport
| std::unique_ptr<TcpSocket> visionary::VisionaryControl::m_pTransport |
|
private |
The documentation for this class was generated from the following files: