Class FieldHeaderVariableCommand

Inheritance Relationships

Base Type

Class Documentation

class FieldHeaderVariableCommand : public sick::cola2::VariableCommand

Command to read the field header variables.

Public Types

typedef sick::cola2::VariableCommand base_class

Typedef to reference the base class.

Public Functions

FieldHeaderVariableCommand(Cola2Session &session, datastructure::FieldData &field_data, const uint16_t &index)

Constructor of the command.

Reads the header of the field variables. Takes the current cola2 session and a reference to the field data, which will be modified during execution. Depending on the sensor up to 128 variables can be defined.

Parameters

  • session – The current cola2 session.

  • field_data – Reference to field data, which will be modified on execution.

  • index – Index of the variable. Can range from [0, 127].

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.