#include <DeviceNameVariableCommand.h>
Public Types | |
| typedef sick::cola2::VariableCommand | base_class |
| Typedef to reference the base class. | |
Public Member Functions | |
| void | addTelegramData (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const |
| Adds the data to the telegram. | |
| 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. | |
| DeviceNameVariableCommand (Cola2Session &session, std::string &device_name) | |
| Constructor of the Command. Takes the current session and the reference for the device name. | |
| bool | processReply () |
| Processes the return from the sensor. | |
Private Attributes | |
| std::string & | m_device_name |
| std::shared_ptr < sick::data_processing::ParseDeviceName > | m_device_name_parser_ptr |
| std::shared_ptr < sick::data_processing::ReadWriteHelper > | m_writer_ptr |
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, |
| std::string & | device_name | ||
| ) |
Constructor of the Command. Takes the current session and the reference for the device name.
- Parameters:
-
session The current cola2 session. device_name The variable to which the device name will be written on execution.
Definition at line 43 of file DeviceNameVariableCommand.cpp.
Member Function Documentation
| void sick::cola2::DeviceNameVariableCommand::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.
Reimplemented from sick::cola2::VariableCommand.
Definition at line 52 of file DeviceNameVariableCommand.cpp.
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.
Reimplemented from sick::cola2::VariableCommand.
Definition at line 58 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.
Reimplemented from sick::cola2::VariableCommand.
Definition at line 63 of file DeviceNameVariableCommand.cpp.
Member Data Documentation
std::string& sick::cola2::DeviceNameVariableCommand::m_device_name [private] |
Definition at line 91 of file DeviceNameVariableCommand.h.
std::shared_ptr<sick::data_processing::ParseDeviceName> sick::cola2::DeviceNameVariableCommand::m_device_name_parser_ptr [private] |
Definition at line 89 of file DeviceNameVariableCommand.h.
std::shared_ptr<sick::data_processing::ReadWriteHelper> sick::cola2::DeviceNameVariableCommand::m_writer_ptr [private] |
Reimplemented from sick::cola2::VariableCommand.
Definition at line 88 of file DeviceNameVariableCommand.h.
The documentation for this class was generated from the following files: