sick::SickSafetyscanners Class Reference

Class managing the algorithmic part of the package. More...

#include <SickSafetyscanners.h>

Public Types
typedef boost::function< void(const sick::datastructure::Data &)>	packetReceivedCallbackFunction

Public Member Functions
void	changeSensorSettings (const sick::datastructure::CommSettings &settings)
	Changes the internal settings of the sensor. More...
void	FindSensor (const datastructure::CommSettings &settings, uint16_t blink_time)
void	requestApplicationName (const sick::datastructure::CommSettings &settings, sick::datastructure::ApplicationName &application_name)
void	requestConfigMetadata (const datastructure::CommSettings &settings, datastructure::ConfigMetadata &config_metadata)
	Requests the config meta data of the sensor. More...
void	requestDeviceName (const sick::datastructure::CommSettings &settings, datastructure::DeviceName &device_name)
	Requests the name of the device from the sensor. More...
void	requestDeviceStatus (const datastructure::CommSettings &settings, datastructure::DeviceStatus &device_status)
void	requestFieldData (const sick::datastructure::CommSettings &settings, std::vector< sick::datastructure::FieldData > &field_data)
	Requests data of the protective and warning fields from the sensor. More...
void	requestFirmwareVersion (const sick::datastructure::CommSettings &settings, sick::datastructure::FirmwareVersion &firmware_version)
	Requests the firmware version of the sensor. More...
void	requestMonitoringCases (const sick::datastructure::CommSettings &settings, std::vector< sick::datastructure::MonitoringCaseData > &monitoring_cases)
	Requests the monitoring cases from the sensor. More...
void	requestOrderNumber (const datastructure::CommSettings &settings, datastructure::OrderNumber &order_number)
void	requestPersistentConfig (const datastructure::CommSettings &settings, sick::datastructure::ConfigData &config_data)
	Requests the persistent configuration from the sensor. More...
void	requestProjectName (const datastructure::CommSettings &settings, datastructure::ProjectName &project_name)
void	requestRequiredUserAction (const datastructure::CommSettings &settings, datastructure::RequiredUserAction &required_user_action)
void	requestSerialNumber (const sick::datastructure::CommSettings &settings, sick::datastructure::SerialNumber &serial_number)
void	requestStatusOverview (const datastructure::CommSettings &settings, datastructure::StatusOverview &status_overview)
void	requestTypeCode (const sick::datastructure::CommSettings &settings, sick::datastructure::TypeCode &type_code)
	Requests the typecode of the sensor. More...
void	requestUserName (const datastructure::CommSettings &settings, datastructure::UserName &user_name)
bool	run ()
	Start the connection to the sensor and enables output. More...
	SickSafetyscanners (const packetReceivedCallbackFunction &newPacketReceivedCallbackFunction, sick::datastructure::CommSettings *settings, boost::asio::ip::address_v4 interface_ip)
	Constructor of the SickSafetyscanners class. More...
virtual	~SickSafetyscanners ()
	Destructor. More...

Private Member Functions
void	changeCommSettingsInColaSession (const datastructure::CommSettings &settings)
void	FindSensorInColaSession (uint16_t blink_time)
void	processTCPPacket (const sick::datastructure::PacketBuffer &buffer)
void	processUDPPacket (const sick::datastructure::PacketBuffer &buffer)
void	requestApplicationNameInColaSession (sick::datastructure::ApplicationName &application_name)
void	requestConfigMetadataInColaSession (sick::datastructure::ConfigMetadata &config_metadata)
void	requestDeviceNameInColaSession (datastructure::DeviceName &device_name)
void	requestDeviceStatusInColaSession (sick::datastructure::DeviceStatus &device_status)
void	requestFieldDataInColaSession (std::vector< sick::datastructure::FieldData > &fields)
void	requestFirmwareVersionInColaSession (sick::datastructure::FirmwareVersion &firmware_version)
void	requestMonitoringCaseDataInColaSession (std::vector< sick::datastructure::MonitoringCaseData > &monitoring_cases)
void	requestOrderNumberInColaSession (sick::datastructure::OrderNumber &order_number)
void	requestPersistentConfigInColaSession (sick::datastructure::ConfigData &config_data)
void	requestProjectNameInColaSession (sick::datastructure::ProjectName &project_name)
void	requestRequiredUserActionInColaSession (sick::datastructure::RequiredUserAction &required_user_action)
void	requestSerialNumberInColaSession (sick::datastructure::SerialNumber &serial_number)
void	requestStatusOverviewInColaSession (sick::datastructure::StatusOverview &status_overview)
void	requestTypeCodeInColaSession (sick::datastructure::TypeCode &type_code)
void	requestUserNameInColaSession (sick::datastructure::UserName &user_name)
void	startTCPConnection (const sick::datastructure::CommSettings &settings)
void	stopTCPConnection ()
bool	udpClientThread ()

Private Attributes
std::shared_ptr< sick::communication::AsyncTCPClient >	m_async_tcp_client_ptr
std::shared_ptr< sick::communication::AsyncUDPClient >	m_async_udp_client_ptr
std::shared_ptr< boost::asio::io_service >	m_io_service_ptr
std::shared_ptr< boost::asio::io_service::work >	m_io_work_ptr
packetReceivedCallbackFunction	m_newPacketReceivedCallbackFunction
std::shared_ptr< sick::data_processing::UDPPacketMerger >	m_packet_merger_ptr
std::shared_ptr< sick::cola2::Cola2Session >	m_session_ptr
boost::scoped_ptr< boost::thread >	m_udp_client_thread_ptr

Detailed Description

Class managing the algorithmic part of the package.

Definition at line 83 of file SickSafetyscanners.h.

Member Typedef Documentation

packetReceivedCallbackFunction

typedef boost::function<void(const sick::datastructure::Data&)> sick::SickSafetyscanners::packetReceivedCallbackFunction

Typedef for function which has to be passed to this class. This enables the use of functions from the calling class.

Definition at line 90 of file SickSafetyscanners.h.

Constructor & Destructor Documentation

SickSafetyscanners()

sick::SickSafetyscanners::SickSafetyscanners	(	const packetReceivedCallbackFunction &	newPacketReceivedCallbackFunction,
		sick::datastructure::CommSettings *	settings,
		boost::asio::ip::address_v4	interface_ip
	)

Constructor of the SickSafetyscanners class.

Parameters

newPacketReceivedCallbackFunction	Function from the calling class, which will be called when a new packet is received.
settings	Current settings for the sensor.

Definition at line 40 of file SickSafetyscanners.cpp.

~SickSafetyscanners()

sick::SickSafetyscanners::~SickSafetyscanners ( )

virtual

Destructor.

Definition at line 73 of file SickSafetyscanners.cpp.

Member Function Documentation

changeCommSettingsInColaSession()

void sick::SickSafetyscanners::changeCommSettingsInColaSession ( const datastructure::CommSettings &  settings )

private

Definition at line 256 of file SickSafetyscanners.cpp.

changeSensorSettings()

void sick::SickSafetyscanners::changeSensorSettings

(

const sick::datastructure::CommSettings &

settings

)

Changes the internal settings of the sensor.

Parameters

settings

New set of settings to pass to the sensor.

Definition at line 104 of file SickSafetyscanners.cpp.

FindSensor()

void sick::SickSafetyscanners::FindSensor	(	const datastructure::CommSettings &	settings,
		uint16_t	blink_time
	)

Definition at line 111 of file SickSafetyscanners.cpp.

FindSensorInColaSession()

void sick::SickSafetyscanners::FindSensorInColaSession ( uint16_t  blink_time )

private

Definition at line 314 of file SickSafetyscanners.cpp.

processTCPPacket()

void sick::SickSafetyscanners::processTCPPacket ( const sick::datastructure::PacketBuffer &  buffer )

private

Definition at line 99 of file SickSafetyscanners.cpp.

processUDPPacket()

void sick::SickSafetyscanners::processUDPPacket ( const sick::datastructure::PacketBuffer &  buffer )

private

Definition at line 449 of file SickSafetyscanners.cpp.

requestApplicationName()

void sick::SickSafetyscanners::requestApplicationName	(	const sick::datastructure::CommSettings &	settings,
		sick::datastructure::ApplicationName &	application_name
	)

Definition at line 127 of file SickSafetyscanners.cpp.

requestApplicationNameInColaSession()

void sick::SickSafetyscanners::requestApplicationNameInColaSession ( sick::datastructure::ApplicationName &  application_name )

private

Definition at line 331 of file SickSafetyscanners.cpp.

requestConfigMetadata()

void sick::SickSafetyscanners::requestConfigMetadata	(	const datastructure::CommSettings &	settings,
		datastructure::ConfigMetadata &	config_metadata
	)

Requests the config meta data of the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
config_metadata	Returned config meta data.

Definition at line 207 of file SickSafetyscanners.cpp.

requestConfigMetadataInColaSession()

void sick::SickSafetyscanners::requestConfigMetadataInColaSession ( sick::datastructure::ConfigMetadata &  config_metadata )

private

Definition at line 397 of file SickSafetyscanners.cpp.

requestDeviceName()

void sick::SickSafetyscanners::requestDeviceName	(	const sick::datastructure::CommSettings &	settings,
		datastructure::DeviceName &	device_name
	)

Requests the name of the device from the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
device_name	Returned device name.

Definition at line 152 of file SickSafetyscanners.cpp.

requestDeviceNameInColaSession()

void sick::SickSafetyscanners::requestDeviceNameInColaSession ( datastructure::DeviceName &  device_name )

private

Definition at line 321 of file SickSafetyscanners.cpp.

requestDeviceStatus()

void sick::SickSafetyscanners::requestDeviceStatus	(	const datastructure::CommSettings &	settings,
		datastructure::DeviceStatus &	device_status
	)

Definition at line 223 of file SickSafetyscanners.cpp.

requestDeviceStatusInColaSession()

void sick::SickSafetyscanners::requestDeviceStatusInColaSession ( sick::datastructure::DeviceStatus &  device_status )

private

Definition at line 415 of file SickSafetyscanners.cpp.

requestFieldData()

void sick::SickSafetyscanners::requestFieldData	(	const sick::datastructure::CommSettings &	settings,
		std::vector< sick::datastructure::FieldData > &	field_data
	)

Requests data of the protective and warning fields from the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
field_data	Returned field data.

Definition at line 135 of file SickSafetyscanners.cpp.

requestFieldDataInColaSession()

void sick::SickSafetyscanners::requestFieldDataInColaSession ( std::vector< sick::datastructure::FieldData > &  fields )

private

Definition at line 264 of file SickSafetyscanners.cpp.

requestFirmwareVersion()

void sick::SickSafetyscanners::requestFirmwareVersion	(	const sick::datastructure::CommSettings &	settings,
		sick::datastructure::FirmwareVersion &	firmware_version
	)

Requests the firmware version of the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
firmware_version	Returned firmware version.

Definition at line 191 of file SickSafetyscanners.cpp.

requestFirmwareVersionInColaSession()

void sick::SickSafetyscanners::requestFirmwareVersionInColaSession ( sick::datastructure::FirmwareVersion &  firmware_version )

private

Definition at line 351 of file SickSafetyscanners.cpp.

requestMonitoringCaseDataInColaSession()

void sick::SickSafetyscanners::requestMonitoringCaseDataInColaSession ( std::vector< sick::datastructure::MonitoringCaseData > &  monitoring_cases )

private

Definition at line 292 of file SickSafetyscanners.cpp.

requestMonitoringCases()

void sick::SickSafetyscanners::requestMonitoringCases	(	const sick::datastructure::CommSettings &	settings,
		std::vector< sick::datastructure::MonitoringCaseData > &	monitoring_cases
	)

Requests the monitoring cases from the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
monitoring_cases	Returned monitoring cases.

Definition at line 143 of file SickSafetyscanners.cpp.

requestOrderNumber()

void sick::SickSafetyscanners::requestOrderNumber	(	const datastructure::CommSettings &	settings,
		datastructure::OrderNumber &	order_number
	)

Definition at line 168 of file SickSafetyscanners.cpp.

requestOrderNumberInColaSession()

void sick::SickSafetyscanners::requestOrderNumberInColaSession ( sick::datastructure::OrderNumber &  order_number )

private

Definition at line 369 of file SickSafetyscanners.cpp.

requestPersistentConfig()

void sick::SickSafetyscanners::requestPersistentConfig	(	const datastructure::CommSettings &	settings,
		sick::datastructure::ConfigData &	config_data
	)

Requests the persistent configuration from the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
config_data	Returned persistent configuration data.

Definition at line 199 of file SickSafetyscanners.cpp.

requestPersistentConfigInColaSession()

void sick::SickSafetyscanners::requestPersistentConfigInColaSession ( sick::datastructure::ConfigData &  config_data )

private

Definition at line 433 of file SickSafetyscanners.cpp.

requestProjectName()

void sick::SickSafetyscanners::requestProjectName	(	const datastructure::CommSettings &	settings,
		datastructure::ProjectName &	project_name
	)

Definition at line 176 of file SickSafetyscanners.cpp.

requestProjectNameInColaSession()

void sick::SickSafetyscanners::requestProjectNameInColaSession ( sick::datastructure::ProjectName &  project_name )

private

Definition at line 379 of file SickSafetyscanners.cpp.

requestRequiredUserAction()

void sick::SickSafetyscanners::requestRequiredUserAction	(	const datastructure::CommSettings &	settings,
		datastructure::RequiredUserAction &	required_user_action
	)

Definition at line 231 of file SickSafetyscanners.cpp.

requestRequiredUserActionInColaSession()

void sick::SickSafetyscanners::requestRequiredUserActionInColaSession ( sick::datastructure::RequiredUserAction &  required_user_action )

private

Definition at line 424 of file SickSafetyscanners.cpp.

requestSerialNumber()

void sick::SickSafetyscanners::requestSerialNumber	(	const sick::datastructure::CommSettings &	settings,
		sick::datastructure::SerialNumber &	serial_number
	)

Definition at line 160 of file SickSafetyscanners.cpp.

requestSerialNumberInColaSession()

void sick::SickSafetyscanners::requestSerialNumberInColaSession ( sick::datastructure::SerialNumber &  serial_number )

private

Definition at line 341 of file SickSafetyscanners.cpp.

requestStatusOverview()

void sick::SickSafetyscanners::requestStatusOverview	(	const datastructure::CommSettings &	settings,
		datastructure::StatusOverview &	status_overview
	)

Definition at line 215 of file SickSafetyscanners.cpp.

requestStatusOverviewInColaSession()

void sick::SickSafetyscanners::requestStatusOverviewInColaSession ( sick::datastructure::StatusOverview &  status_overview )

private

Definition at line 406 of file SickSafetyscanners.cpp.

requestTypeCode()

void sick::SickSafetyscanners::requestTypeCode	(	const sick::datastructure::CommSettings &	settings,
		sick::datastructure::TypeCode &	type_code
	)

Requests the typecode of the sensor.

Parameters

settings	Settings containing information to establish a connection to the sensor.
type_code	Returned typecode.

Definition at line 119 of file SickSafetyscanners.cpp.

requestTypeCodeInColaSession()

void sick::SickSafetyscanners::requestTypeCodeInColaSession ( sick::datastructure::TypeCode &  type_code )

private

Definition at line 361 of file SickSafetyscanners.cpp.

requestUserName()

void sick::SickSafetyscanners::requestUserName	(	const datastructure::CommSettings &	settings,
		datastructure::UserName &	user_name
	)

Definition at line 184 of file SickSafetyscanners.cpp.

requestUserNameInColaSession()

void sick::SickSafetyscanners::requestUserNameInColaSession ( sick::datastructure::UserName &  user_name )

private

Definition at line 389 of file SickSafetyscanners.cpp.

run()

bool sick::SickSafetyscanners::run

(

)

Start the connection to the sensor and enables output.

Returns

If the setup was correct.

Definition at line 80 of file SickSafetyscanners.cpp.

startTCPConnection()

void sick::SickSafetyscanners::startTCPConnection ( const sick::datastructure::CommSettings &  settings )

private

Definition at line 240 of file SickSafetyscanners.cpp.

stopTCPConnection()

void sick::SickSafetyscanners::stopTCPConnection ( )

private

Definition at line 442 of file SickSafetyscanners.cpp.

udpClientThread()

bool sick::SickSafetyscanners::udpClientThread ( )

private

Definition at line 89 of file SickSafetyscanners.cpp.

Member Data Documentation

m_async_tcp_client_ptr

std::shared_ptr<sick::communication::AsyncTCPClient> sick::SickSafetyscanners::m_async_tcp_client_ptr

private

Definition at line 204 of file SickSafetyscanners.h.

m_async_udp_client_ptr

std::shared_ptr<sick::communication::AsyncUDPClient> sick::SickSafetyscanners::m_async_udp_client_ptr

private

Definition at line 203 of file SickSafetyscanners.h.

m_io_service_ptr

std::shared_ptr<boost::asio::io_service> sick::SickSafetyscanners::m_io_service_ptr

private

Definition at line 201 of file SickSafetyscanners.h.

m_io_work_ptr

std::shared_ptr<boost::asio::io_service::work> sick::SickSafetyscanners::m_io_work_ptr

private

Definition at line 202 of file SickSafetyscanners.h.

m_newPacketReceivedCallbackFunction

packetReceivedCallbackFunction sick::SickSafetyscanners::m_newPacketReceivedCallbackFunction

private

Definition at line 199 of file SickSafetyscanners.h.

m_packet_merger_ptr

std::shared_ptr<sick::data_processing::UDPPacketMerger> sick::SickSafetyscanners::m_packet_merger_ptr

private

Definition at line 209 of file SickSafetyscanners.h.

m_session_ptr

std::shared_ptr<sick::cola2::Cola2Session> sick::SickSafetyscanners::m_session_ptr

private

Definition at line 207 of file SickSafetyscanners.h.

m_udp_client_thread_ptr

boost::scoped_ptr<boost::thread> sick::SickSafetyscanners::m_udp_client_thread_ptr

private

Definition at line 205 of file SickSafetyscanners.h.

---

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

• SickSafetyscanners.h
• SickSafetyscanners.cpp