Command to read a variable from the sensor. More...
#include <VariableCommand.h>
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. | |
| uint16_t | getVariableIndex () const |
| bool | processReply () |
| Processes the return from the sensor. | |
| void | setVariableIndex (const uint16_t &variable_index) |
| VariableCommand (Cola2Session &session, const uint16_t &method_index) | |
| Constructor of the command. | |
Private Attributes | |
| uint16_t | m_variable_index |
| std::shared_ptr < sick::data_processing::ReadWriteHelper > | m_writer_ptr |
Detailed Description
Command to read a variable from the sensor.
Definition at line 46 of file VariableCommand.h.
Constructor & Destructor Documentation
| sick::cola2::VariableCommand::VariableCommand | ( | Cola2Session & | session, |
| const uint16_t & | method_index | ||
| ) |
Constructor of the command.
- Parameters:
-
session The current cola2 session. method_index The index of the variable.
Definition at line 43 of file VariableCommand.cpp.
Member Function Documentation
| void sick::cola2::VariableCommand::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.
Reimplemented in sick::cola2::FieldGeometryVariableCommand, sick::cola2::FieldHeaderVariableCommand, sick::cola2::MeasurementPersistentConfigVariableCommand, sick::cola2::MonitoringCaseVariableCommand, sick::cola2::MeasurementCurrentConfigVariableCommand, sick::cola2::MonitoringCaseTableHeaderVariableCommand, sick::cola2::TypeCodeVariableCommand, and sick::cola2::DeviceNameVariableCommand.
Definition at line 50 of file VariableCommand.cpp.
| bool sick::cola2::VariableCommand::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.
Reimplemented in sick::cola2::FieldGeometryVariableCommand, sick::cola2::FieldHeaderVariableCommand, sick::cola2::MeasurementPersistentConfigVariableCommand, sick::cola2::MonitoringCaseVariableCommand, sick::cola2::MeasurementCurrentConfigVariableCommand, sick::cola2::MonitoringCaseTableHeaderVariableCommand, sick::cola2::TypeCodeVariableCommand, and sick::cola2::DeviceNameVariableCommand.
Definition at line 59 of file VariableCommand.cpp.
| uint16_t sick::cola2::VariableCommand::getVariableIndex | ( | ) | const |
Definition at line 79 of file VariableCommand.cpp.
| bool sick::cola2::VariableCommand::processReply | ( | ) | [virtual] |
Processes the return from the sensor.
- Returns:
- If processing of the returned data was successful.
Implements sick::cola2::Command.
Reimplemented in sick::cola2::FieldGeometryVariableCommand, sick::cola2::FieldHeaderVariableCommand, sick::cola2::MeasurementPersistentConfigVariableCommand, sick::cola2::MonitoringCaseVariableCommand, sick::cola2::MeasurementCurrentConfigVariableCommand, sick::cola2::MonitoringCaseTableHeaderVariableCommand, sick::cola2::TypeCodeVariableCommand, and sick::cola2::DeviceNameVariableCommand.
Definition at line 64 of file VariableCommand.cpp.
| void sick::cola2::VariableCommand::setVariableIndex | ( | const uint16_t & | variable_index | ) |
Definition at line 84 of file VariableCommand.cpp.
Member Data Documentation
uint16_t sick::cola2::VariableCommand::m_variable_index [private] |
Definition at line 83 of file VariableCommand.h.
std::shared_ptr<sick::data_processing::ReadWriteHelper> sick::cola2::VariableCommand::m_writer_ptr [private] |
Reimplemented from sick::cola2::Command.
Reimplemented in sick::cola2::FieldGeometryVariableCommand, sick::cola2::FieldHeaderVariableCommand, sick::cola2::MeasurementPersistentConfigVariableCommand, sick::cola2::MonitoringCaseVariableCommand, sick::cola2::MeasurementCurrentConfigVariableCommand, sick::cola2::MonitoringCaseTableHeaderVariableCommand, sick::cola2::TypeCodeVariableCommand, and sick::cola2::DeviceNameVariableCommand.
Definition at line 84 of file VariableCommand.h.
The documentation for this class was generated from the following files: