Public Member Functions | List of all members
sick::cola2::CloseSession Class Reference

Command to close a cola2 session between host and sensor. More...

#include <CloseSession.h>

Inheritance diagram for sick::cola2::CloseSession:
Inheritance graph
[legend]

Public Member Functions

std::vector< uint8_t > addTelegramData (const std::vector< uint8_t > &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. More...
 
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. More...
 
 CloseSession (Cola2Session &session)
 Constructor of the command to close a cola2 session. More...
 
bool processReply ()
 Processes the return from the sensor. More...
 
- Public Member Functions inherited from sick::cola2::Command
 Command (sick::cola2::Cola2Session &session, const uint16_t &command_type, const uint16_t &command_mode)
 Constructor of the command. Sets the common variables for a command to the sensor. More...
 
std::vector< uint8_t > constructTelegram (const std::vector< uint8_t > &telegram) const
 Adds the data to the telegram and afterwards the header with the correct length. More...
 
uint8_t getCommandMode () const
 Returns the command mode. More...
 
uint8_t getCommandType () const
 Returns the command type. More...
 
std::vector< uint8_t > getDataVector () const
 Returns the data vector. More...
 
uint16_t getRequestID () const
 Returns the request id of the command. More...
 
uint32_t getSessionID () const
 Returns the current session ID. More...
 
void lockExecutionMutex ()
 Locks a mutex to prevent other commands being executed in parallel. More...
 
void processReplyBase (const std::vector< uint8_t > &packet)
 Parses the da incoming data package and then processes it with the inherited processReply. Afterwards the mutex will be unlocked to allow new commands to be send. More...
 
void setCommandMode (const uint8_t &command_mode)
 Sets the command mode. More...
 
void setCommandType (const uint8_t &command_type)
 Sets the command type. More...
 
void setDataVector (const std::vector< uint8_t > &data)
 Sets the data vector. More...
 
void setRequestID (const uint16_t &request_id)
 Sets the request ID of the command. More...
 
void setSessionID (const uint32_t &session_id)
 Sets the session ID. More...
 
void waitForCompletion ()
 Scooped call to the mutex, which will block until the reply was processed. More...
 
bool wasSuccessful () const
 Returns if the command was successfully parsed. More...
 
virtual ~Command ()
 We have virtual member functions, so a virtual destructor is needed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from sick::cola2::Command
std::vector< uint8_t > expandTelegram (const std::vector< uint8_t > &telegram, size_t additional_bytes) const
 
- Protected Attributes inherited from sick::cola2::Command
sick::cola2::Cola2Sessionm_session
 

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
sessionThe currents cola2 session, which will be closed on executing the command.

Definition at line 44 of file CloseSession.cpp.

Member Function Documentation

std::vector< uint8_t > sick::cola2::CloseSession::addTelegramData ( const std::vector< uint8_t > &  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
telegramThe telegram which will be modified. &
Returns
Completed telegram.

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 54 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 59 of file CloseSession.cpp.


The documentation for this class was generated from the following files:


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Fri Apr 2 2021 02:45:42