Command to create a new cola2 session. More...
#include <CreateSession.h>
Public Member Functions | |
| void | addTelegramData (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const |
| Adds the data to the telegram. | |
| bool | canBeExecutedWithoutSessionID () const |
| Returns true since creating a new session is possible without a session ID. | |
| CreateSession (Cola2Session &session) | |
| Constructor to create a new command to set up a new session. | |
| bool | processReply () |
| Processes the return from the sensor. Checks if the request was successful. | |
Private Member Functions | |
| uint8_t * | prepareTelegramAndGetDataPtr (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const |
| void | writeClientIdToDataPtr (uint8_t *&data_ptr) const |
| void | writeHeartbeatTimeoutToDataPtr (uint8_t *&data_ptr) const |
Private Attributes | |
| std::shared_ptr < sick::data_processing::ReadWriteHelper > | m_writer_ptr |
Detailed Description
Command to create a new cola2 session.
Definition at line 47 of file CreateSession.h.
Constructor & Destructor Documentation
| sick::cola2::CreateSession::CreateSession | ( | Cola2Session & | session | ) | [explicit] |
Constructor to create a new command to set up a new session.
- Parameters:
-
session The new session which will be setup.
Definition at line 43 of file CreateSession.cpp.
Member Function Documentation
| void sick::cola2::CreateSession::addTelegramData | ( | sick::datastructure::PacketBuffer::VectorBuffer & | telegram | ) | const [virtual] |
Adds the data to the telegram.
- Parameters:
-
telegram The telegram which will be modified by the data.
Implements sick::cola2::Command.
Definition at line 49 of file CreateSession.cpp.
| bool sick::cola2::CreateSession::canBeExecutedWithoutSessionID | ( | ) | const |
Returns true since creating a new session is possible without a session ID.
- Returns:
- true.
Definition at line 64 of file CreateSession.cpp.
| uint8_t * sick::cola2::CreateSession::prepareTelegramAndGetDataPtr | ( | sick::datastructure::PacketBuffer::VectorBuffer & | telegram | ) | const [private] |
Definition at line 56 of file CreateSession.cpp.
| bool sick::cola2::CreateSession::processReply | ( | ) | [virtual] |
Processes the return from the sensor. Checks if the request was successful.
- Returns:
- If processing of the returned data was successful.
Implements sick::cola2::Command.
Definition at line 69 of file CreateSession.cpp.
| void sick::cola2::CreateSession::writeClientIdToDataPtr | ( | uint8_t *& | data_ptr | ) | const [private] |
Definition at line 91 of file CreateSession.cpp.
| void sick::cola2::CreateSession::writeHeartbeatTimeoutToDataPtr | ( | uint8_t *& | data_ptr | ) | const [private] |
Definition at line 85 of file CreateSession.cpp.
Member Data Documentation
std::shared_ptr<sick::data_processing::ReadWriteHelper> sick::cola2::CreateSession::m_writer_ptr [private] |
Reimplemented from sick::cola2::Command.
Definition at line 79 of file CreateSession.h.
The documentation for this class was generated from the following files: