Public Types | Public Member Functions | Private Attributes
sick::cola2::FieldGeometryVariableCommand Class Reference

Command to read the field geometry from the sensor. More...

#include <FieldGeometryVariableCommand.h>

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

List of all members.

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.
 FieldGeometryVariableCommand (Cola2Session &session, datastructure::FieldData &field_data, const uint16_t index)
 Constructor of the command.
bool processReply ()
 Processes the return from the sensor.

Private Attributes

sick::datastructure::FieldDatam_field_data
std::shared_ptr
< sick::data_processing::ParseFieldGeometryData
m_field_geometry_parser_ptr
std::shared_ptr
< sick::data_processing::ReadWriteHelper
m_writer_ptr

Detailed Description

Command to read the field geometry from the sensor.

Definition at line 49 of file FieldGeometryVariableCommand.h.


Member Typedef Documentation

Typedef to reference the base class.

Definition at line 55 of file FieldGeometryVariableCommand.h.


Constructor & Destructor Documentation

Constructor of the command.

Takes the current cola2 session and a reference to the field data variable which will be written on execution. The index defines which field variable will be read. Depending on the sensor up to 128 variables can be defined.

Parameters:
sessionThe current cola2 session.
field_dataThe field data reference which will be modified on execution.
indexThe variable index in a range of [0, 127].

Definition at line 43 of file FieldGeometryVariableCommand.cpp.


Member Function Documentation

Adds the data to the telegram.

Parameters:
telegramThe telegram which will be modified by the data.

Reimplemented from sick::cola2::VariableCommand.

Definition at line 53 of file FieldGeometryVariableCommand.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 59 of file FieldGeometryVariableCommand.cpp.

Processes the return from the sensor.

Returns:
If processing of the returned data was successful.

Reimplemented from sick::cola2::VariableCommand.

Definition at line 64 of file FieldGeometryVariableCommand.cpp.


Member Data Documentation

Definition at line 99 of file FieldGeometryVariableCommand.h.

Definition at line 97 of file FieldGeometryVariableCommand.h.

Reimplemented from sick::cola2::VariableCommand.

Definition at line 96 of file FieldGeometryVariableCommand.h.


The documentation for this class was generated from the following files:


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Tue May 7 2019 03:27:37