Method command class for changing the settings in the sensor. Such as which data packages to enable. More...

#include <ChangeCommSettingsCommand.h>

Inheritance diagram for sick::cola2::ChangeCommSettingsCommand:

Public Types
typedef sick::cola2::MethodCommand	base_class
	Typedef to reference the base class.
Public Member Functions
void	addTelegramData (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const
	Adds the settings as data to the packetbuffer.
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.
	ChangeCommSettingsCommand (Cola2Session &session, const datastructure::CommSettings &settings)
	Constructor of the Command, takes the current session and the new set of parameters for the sensor.
bool	processReply ()
	Processes the return from the sensor. Checks if the method was acknowledged by the sensor.
Private Member Functions
uint8_t *	prepareTelegramAndGetDataPtr (sick::datastructure::PacketBuffer::VectorBuffer &telegram) const
void	writeChannelToDataPtr (uint8_t *&data_ptr) const
void	writeDataToDataPtr (uint8_t *&data_ptr) const
void	writeEInterfaceTypeToDataPtr (uint8_t *&data_ptr) const
void	writeEnabledToDataPtr (uint8_t *&data_ptr) const
void	writeEndAngleToDataPtr (uint8_t *&data_ptr) const
void	writeFeaturesToDataPtr (uint8_t *&data_ptr) const
void	writeFrequencyToDataPtr (uint8_t *&data_ptr) const
void	writeIPAddresstoDataPtr (uint8_t *&data_ptr) const
void	writePortToDataPtr (uint8_t *&data_ptr) const
void	writeStartAngleToDataPtr (uint8_t *&data_ptr) const
Private Attributes
sick::datastructure::CommSettings	m_settings
std::shared_ptr < sick::data_processing::ReadWriteHelper >	m_writer_ptr

Detailed Description

Method command class for changing the settings in the sensor. Such as which data packages to enable.

Definition at line 51 of file ChangeCommSettingsCommand.h.

Member Typedef Documentation

typedef sick::cola2::MethodCommand sick::cola2::ChangeCommSettingsCommand::base_class

Typedef to reference the base class.

Definition at line 57 of file ChangeCommSettingsCommand.h.

Constructor & Destructor Documentation

sick::cola2::ChangeCommSettingsCommand::ChangeCommSettingsCommand	(	Cola2Session &	session,
		const datastructure::CommSettings &	settings
	)

Constructor of the Command, takes the current session and the new set of parameters for the sensor.

Parameters:

session	The current Cola2 session, in which the parameters should be transferred.
settings	The new settings for the sensor. While the command will be executed in the session, these parameters will be set in the sensor.

Definition at line 44 of file ChangeCommSettingsCommand.cpp.

Member Function Documentation

void sick::cola2::ChangeCommSettingsCommand::addTelegramData ( sick::datastructure::PacketBuffer::VectorBuffer & telegram ) const [virtual]

Adds the settings as data to the packetbuffer.

Parameters:

telegram The telegram, which will be modified the settings as data.

Reimplemented from sick::cola2::MethodCommand.

Definition at line 52 of file ChangeCommSettingsCommand.cpp.

bool sick::cola2::ChangeCommSettingsCommand::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 from sick::cola2::MethodCommand.

Definition at line 83 of file ChangeCommSettingsCommand.cpp.

uint8_t * sick::cola2::ChangeCommSettingsCommand::prepareTelegramAndGetDataPtr ( sick::datastructure::PacketBuffer::VectorBuffer & telegram ) const [private]

Definition at line 62 of file ChangeCommSettingsCommand.cpp.

bool sick::cola2::ChangeCommSettingsCommand::processReply ( ) [virtual]

Processes the return from the sensor. Checks if the method was acknowledged by the sensor.

Returns:: If processing of the returned data was successful.

Reimplemented from sick::cola2::MethodCommand.

Definition at line 88 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeChannelToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 97 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeDataToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 70 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeEInterfaceTypeToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 107 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeEnabledToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 102 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeEndAngleToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 132 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeFeaturesToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 137 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeFrequencyToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 122 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeIPAddresstoDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 112 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writePortToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 117 of file ChangeCommSettingsCommand.cpp.

void sick::cola2::ChangeCommSettingsCommand::writeStartAngleToDataPtr ( uint8_t *& data_ptr ) const [private]

Definition at line 127 of file ChangeCommSettingsCommand.cpp.

Member Data Documentation

sick::datastructure::CommSettings sick::cola2::ChangeCommSettingsCommand::m_settings [private]

Definition at line 98 of file ChangeCommSettingsCommand.h.

std::shared_ptr<sick::data_processing::ReadWriteHelper> sick::cola2::ChangeCommSettingsCommand::m_writer_ptr [private]

Reimplemented from sick::cola2::MethodCommand.

Definition at line 97 of file ChangeCommSettingsCommand.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation