Class VariableCommand

• Defined in File VariableCommand.h

Inheritance Relationships

Base Type

• public sick::cola2::Command (Class Command)

Derived Types

• public sick::cola2::ApplicationNameVariableCommand (Class ApplicationNameVariableCommand)

• public sick::cola2::ConfigMetadataVariableCommand (Class ConfigMetadataVariableCommand)

• public sick::cola2::DeviceNameVariableCommand (Class DeviceNameVariableCommand)

• public sick::cola2::DeviceStatusVariableCommand (Class DeviceStatusVariableCommand)

• public sick::cola2::FieldGeometryVariableCommand (Class FieldGeometryVariableCommand)

• public sick::cola2::FieldHeaderVariableCommand (Class FieldHeaderVariableCommand)

• public sick::cola2::FieldSetsVariableCommand (Class FieldSetsVariableCommand)

• public sick::cola2::FirmwareVersionVariableCommand (Class FirmwareVersionVariableCommand)

• public sick::cola2::LatestTelegramVariableCommand (Class LatestTelegramVariableCommand)

• public sick::cola2::MeasurementCurrentConfigVariableCommand (Class MeasurementCurrentConfigVariableCommand)

• public sick::cola2::MeasurementPersistentConfigVariableCommand (Class MeasurementPersistentConfigVariableCommand)

• public sick::cola2::MonitoringCaseTableHeaderVariableCommand (Class MonitoringCaseTableHeaderVariableCommand)

• public sick::cola2::MonitoringCaseVariableCommand (Class MonitoringCaseVariableCommand)

• public sick::cola2::OrderNumberVariableCommand (Class OrderNumberVariableCommand)

• public sick::cola2::ProjectNameVariableCommand (Class ProjectNameVariableCommand)

• public sick::cola2::RequiredUserActionVariableCommand (Class RequiredUserActionVariableCommand)

• public sick::cola2::SerialNumberVariableCommand (Class SerialNumberVariableCommand)

• public sick::cola2::StatusOverviewVariableCommand (Class StatusOverviewVariableCommand)

• public sick::cola2::TypeCodeVariableCommand (Class TypeCodeVariableCommand)

• public sick::cola2::UserNameVariableCommand (Class UserNameVariableCommand)

Class Documentation

class VariableCommand : public sick::cola2::Command

Command to read a variable from the sensor.

Subclassed by sick::cola2::ApplicationNameVariableCommand, sick::cola2::ConfigMetadataVariableCommand, sick::cola2::DeviceNameVariableCommand, sick::cola2::DeviceStatusVariableCommand, sick::cola2::FieldGeometryVariableCommand, sick::cola2::FieldHeaderVariableCommand, sick::cola2::FieldSetsVariableCommand, sick::cola2::FirmwareVersionVariableCommand, sick::cola2::LatestTelegramVariableCommand, sick::cola2::MeasurementCurrentConfigVariableCommand, sick::cola2::MeasurementPersistentConfigVariableCommand, sick::cola2::MonitoringCaseTableHeaderVariableCommand, sick::cola2::MonitoringCaseVariableCommand, sick::cola2::OrderNumberVariableCommand, sick::cola2::ProjectNameVariableCommand, sick::cola2::RequiredUserActionVariableCommand, sick::cola2::SerialNumberVariableCommand, sick::cola2::StatusOverviewVariableCommand, sick::cola2::TypeCodeVariableCommand, sick::cola2::UserNameVariableCommand

Public Functions

VariableCommand(Cola2Session &session, const uint16_t &variable_index)

Constructor of the command.

Parameters

• session – The current cola2 session.

• method_index – The index of the variable.

virtual std::vector<uint8_t> addTelegramData(const std::vector<uint8_t> &telegram) const

Adds the data to the telegram.

Parameters

telegram – The telegram which will be modified by the data.

Returns

Completed 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.

Returns

If the command needs a session ID to be executed.

virtual bool processReply()

Processes the return from the sensor.

Returns

If processing of the returned data was successful.

uint16_t getVariableIndex() const

void setVariableIndex(const uint16_t &variable_index)