Command to close a cola2 session between host and sensor. More...
#include <CloseSession.h>
Public Member Functions | |
| void | addTelegramData (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const |
| Adds data to the telegram. The close cola2 session command does not carry any extra data and therefor this function does not add any data. | |
| bool | canBeExecutedWithoutSessionID () const |
| Returns if the command can be executed without a session ID. Will return false for most commands except the commands to establish a connection. | |
| CloseSession (Cola2Session &session) | |
| Constructor of the command to close a cola2 session. | |
| bool | processReply () |
| Processes the return from the sensor. | |
Detailed Description
Command to close a cola2 session between host and sensor.
Definition at line 47 of file CloseSession.h.
Constructor & Destructor Documentation
| sick::cola2::CloseSession::CloseSession | ( | Cola2Session & | session | ) | [explicit] |
Constructor of the command to close a cola2 session.
- Parameters:
-
session The currents cola2 session, which will be closed on executing the command.
Definition at line 44 of file CloseSession.cpp.
Member Function Documentation
| void sick::cola2::CloseSession::addTelegramData | ( | sick::datastructure::PacketBuffer::VectorBuffer & | telegram | ) | const [virtual] |
Adds data to the telegram. The close cola2 session command does not carry any extra data and therefor this function does not add any data.
- Parameters:
-
telegram The telegram which will be modified.
Implements sick::cola2::Command.
Definition at line 49 of file CloseSession.cpp.
| bool sick::cola2::CloseSession::canBeExecutedWithoutSessionID | ( | ) | const |
Returns if the command can be executed without a session ID. Will return false for most commands except the commands to establish a connection.
- Returns:
- If the command needs a session ID to be executed.
Definition at line 53 of file CloseSession.cpp.
| bool sick::cola2::CloseSession::processReply | ( | ) | [virtual] |
Processes the return from the sensor.
- Returns:
- If processing of the returned data was successful.
Implements sick::cola2::Command.
Definition at line 58 of file CloseSession.cpp.
The documentation for this class was generated from the following files: