Public Types | Public Member Functions | Private Attributes | List of all members
sick::cola2::DeviceNameVariableCommand Class Reference

#include <DeviceNameVariableCommand.h>

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

Public Types

typedef sick::cola2::VariableCommand base_class
 Typedef to reference the base class. More...
 

Public Member Functions

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...
 
 DeviceNameVariableCommand (Cola2Session &session, datastructure::DeviceName &device_name)
 Constructor of the Command. Takes the current session and the reference for the device name. More...
 
bool processReply ()
 Processes the return from the sensor. More...
 
- Public Member Functions inherited from sick::cola2::VariableCommand
std::vector< uint8_t > addTelegramData (const std::vector< uint8_t > &telegram) const
 Adds the data to the telegram. 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...
 
uint16_t getVariableIndex () const
 
bool processReply ()
 Processes the return from the sensor. More...
 
void setVariableIndex (const uint16_t &variable_index)
 
 VariableCommand (Cola2Session &session, const uint16_t &variable_index)
 Constructor of the command. 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...
 

Private Attributes

datastructure::DeviceNamem_device_name
 
std::shared_ptr< sick::data_processing::ParseDeviceNamem_device_name_parser_ptr
 

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

Definition at line 47 of file DeviceNameVariableCommand.h.

Member Typedef Documentation

Typedef to reference the base class.

Definition at line 53 of file DeviceNameVariableCommand.h.

Constructor & Destructor Documentation

sick::cola2::DeviceNameVariableCommand::DeviceNameVariableCommand ( Cola2Session session,
datastructure::DeviceName device_name 
)

Constructor of the Command. Takes the current session and the reference for the device name.

Parameters
sessionThe current cola2 session.
device_nameThe variable to which the device name will be written on execution.

Definition at line 43 of file DeviceNameVariableCommand.cpp.

Member Function Documentation

bool sick::cola2::DeviceNameVariableCommand::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 51 of file DeviceNameVariableCommand.cpp.

bool sick::cola2::DeviceNameVariableCommand::processReply ( )
virtual

Processes the return from the sensor.

Returns
If processing of the returned data was successful.

Implements sick::cola2::Command.

Definition at line 56 of file DeviceNameVariableCommand.cpp.

Member Data Documentation

datastructure::DeviceName& sick::cola2::DeviceNameVariableCommand::m_device_name
private

Definition at line 83 of file DeviceNameVariableCommand.h.

std::shared_ptr<sick::data_processing::ParseDeviceName> sick::cola2::DeviceNameVariableCommand::m_device_name_parser_ptr
private

Definition at line 81 of file DeviceNameVariableCommand.h.


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