Command to read the field header variables. More...

#include <FieldHeaderVariableCommand.h>

Inheritance diagram for sick::cola2::FieldHeaderVariableCommand:

Public Types
typedef sick::cola2::VariableCommand	base_class
	Typedef to reference the base class. More...

Public Member Functions
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. More...

	FieldHeaderVariableCommand (Cola2Session &session, datastructure::FieldData &field_data, const uint16_t &index)
	Constructor of the command. More...

bool	processReply ()
	Processes the return from the sensor. More...

Public Member Functions inherited from sick::cola2::VariableCommand
std::vector< uint8_t >	addTelegramData (const std::vector< uint8_t > &telegram) const
	Adds the data to the telegram. More...

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

uint16_t	getVariableIndex () const

bool	processReply ()
	Processes the return from the sensor. More...

void	setVariableIndex (const uint16_t &variable_index)

	VariableCommand (Cola2Session &session, const uint16_t &variable_index)
	Constructor of the command. More...

Public Member Functions inherited from sick::cola2::Command
	Command (sick::cola2::Cola2Session &session, const uint16_t &command_type, const uint16_t &command_mode)
	Constructor of the command. Sets the common variables for a command to the sensor. More...

std::vector< uint8_t >	constructTelegram (const std::vector< uint8_t > &telegram) const
	Adds the data to the telegram and afterwards the header with the correct length. More...

uint8_t	getCommandMode () const
	Returns the command mode. More...

uint8_t	getCommandType () const
	Returns the command type. More...

std::vector< uint8_t >	getDataVector () const
	Returns the data vector. More...

uint16_t	getRequestID () const
	Returns the request id of the command. More...

uint32_t	getSessionID () const
	Returns the current session ID. More...

void	lockExecutionMutex ()
	Locks a mutex to prevent other commands being executed in parallel. More...

void	processReplyBase (const std::vector< uint8_t > &packet)
	Parses the da incoming data package and then processes it with the inherited processReply. Afterwards the mutex will be unlocked to allow new commands to be send. More...

void	setCommandMode (const uint8_t &command_mode)
	Sets the command mode. More...

void	setCommandType (const uint8_t &command_type)
	Sets the command type. More...

void	setDataVector (const std::vector< uint8_t > &data)
	Sets the data vector. More...

void	setRequestID (const uint16_t &request_id)
	Sets the request ID of the command. More...

void	setSessionID (const uint32_t &session_id)
	Sets the session ID. More...

void	waitForCompletion ()
	Scooped call to the mutex, which will block until the reply was processed. More...

bool	wasSuccessful () const
	Returns if the command was successfully parsed. More...

virtual	~Command ()
	We have virtual member functions, so a virtual destructor is needed. More...

Private Attributes
sick::datastructure::FieldData &	m_field_data

std::shared_ptr< sick::data_processing::ParseFieldHeaderData >	m_field_header_parser_ptr

Additional Inherited Members
Protected Member Functions inherited from sick::cola2::Command
std::vector< uint8_t >	expandTelegram (const std::vector< uint8_t > &telegram, size_t additional_bytes) const

Protected Attributes inherited from sick::cola2::Command
sick::cola2::Cola2Session &	m_session

Detailed Description

Command to read the field header variables.

Definition at line 49 of file FieldHeaderVariableCommand.h.

Member Typedef Documentation

◆ base_class

typedef sick::cola2::VariableCommand sick::cola2::FieldHeaderVariableCommand::base_class

Typedef to reference the base class.

Definition at line 55 of file FieldHeaderVariableCommand.h.

Constructor & Destructor Documentation

◆ FieldHeaderVariableCommand()

sick::cola2::FieldHeaderVariableCommand::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].

Definition at line 43 of file FieldHeaderVariableCommand.cpp.