Containing the communication settings for the sensor which can be changed on runtime. More...

#include <CommSettings.h>

Public Member Functions
	CommSettings ()
	Constructor of the communication settings. More...

uint8_t	getChannel () const
	Gets the channel of the data. More...

uint8_t	getEInterfaceType () const
	Gets the eInterface type. More...

bool	getEnabled () const
	Gets if the channel is enabled. More...

uint32_t	getEndAngle () const
	Gets the end angle of the scan. More...

uint16_t	getFeatures () const
	Gets the enabled features. More...

boost::asio::ip::address_v4	getHostIp () const
	Gets the IP-address of the host. More...

uint16_t	getHostUdpPort () const
	Gets the host udp port. More...

uint16_t	getPublishingFrequency () const
	Gets the publishing frequency. More...

boost::asio::ip::address_v4	getSensorIp () const
	Gets the sensor IP-address. More...

uint16_t	getSensorTcpPort () const
	Gets the sensor tcp port. More...

uint32_t	getStartAngle () const
	Gets the start angle of the scan. More...

void	setChannel (const uint8_t &channel)
	Sets the channel of the data. More...

void	setEInterfaceType (const uint8_t &e_interface_type)
	Sets the eInterface type. More...

void	setEnabled (bool enabled)
	Sets if the channel is enabled. More...

void	setEndAngle (const uint32_t &end_angle)
	Sets the end angle of the scan. More...

void	setFeatures (const uint16_t &features)
	Set the enabled features. More...

void	setFeatures (const bool general_system_state, const bool derived_settings, const bool measurement_data, const bool intrusion_data, const bool application_data)
	Sets the enabled features. More...

void	setHostIp (const boost::asio::ip::address_v4 &host_ip)
	Sets the IP-address of the host from an IP-address. More...

void	setHostIp (const std::string &host_ip)
	Sets the IP-address of the host from a string. More...

void	setHostUdpPort (const uint16_t &host_udp_port)
	Sets the host udp port. More...

void	setPublishingFrequency (const uint16_t &publishing_frequency)
	Sets the publishing frequency. More...

void	setSensorIp (const boost::asio::ip::address_v4 &sensor_ip)
	Sets the sensor IP-address. More...

void	setSensorIp (const std::string &sensor_ip)
	Sets the sensor IP-address from a string. More...

void	setSensorTcpPort (const uint16_t &sensor_tcp_port)
	Sets the sensor tcp port. More...

void	setStartAngle (const uint32_t &start_angle)
	Sets the start angle of the scan. More...

Private Attributes
uint8_t	m_channel

uint8_t	m_e_interface_type

bool	m_enabled

uint32_t	m_end_angle

uint16_t	m_features

boost::asio::ip::address_v4	m_host_ip

uint16_t	m_host_udp_port

uint16_t	m_publishing_frequency

boost::asio::ip::address_v4	m_sensor_ip

uint16_t	m_sensor_tcp_port

uint32_t	m_start_angle

Detailed Description

Containing the communication settings for the sensor which can be changed on runtime.

Definition at line 48 of file CommSettings.h.

Constructor & Destructor Documentation

sick::datastructure::CommSettings::CommSettings ( )

Constructor of the communication settings.

Definition at line 40 of file CommSettings.cpp.

Member Function Documentation

uint8_t sick::datastructure::CommSettings::getChannel ( ) const

Gets the channel of the data.

Returns: The channel of the data.

Definition at line 67 of file CommSettings.cpp.

uint8_t sick::datastructure::CommSettings::getEInterfaceType ( ) const

Gets the eInterface type.

Returns: The eInterface type.

Definition at line 87 of file CommSettings.cpp.

bool sick::datastructure::CommSettings::getEnabled ( ) const

Gets if the channel is enabled.

Returns: If the channel is enabled.

Definition at line 77 of file CommSettings.cpp.

uint32_t sick::datastructure::CommSettings::getEndAngle ( ) const

Gets the end angle of the scan.

Returns: The end angle of the scan.

Definition at line 117 of file CommSettings.cpp.

uint16_t sick::datastructure::CommSettings::getFeatures ( ) const

Gets the enabled features.

Returns: The enabled features.

Definition at line 127 of file CommSettings.cpp.

boost::asio::ip::address_v4 sick::datastructure::CommSettings::getHostIp ( ) const

Gets the IP-address of the host.

Returns: The IP-address of the host.

Definition at line 42 of file CommSettings.cpp.

uint16_t sick::datastructure::CommSettings::getHostUdpPort ( ) const

Gets the host udp port.

Returns: The host udp port.

Definition at line 57 of file CommSettings.cpp.

uint16_t sick::datastructure::CommSettings::getPublishingFrequency ( ) const

Gets the publishing frequency.

Returns: The publishing frequency.

Definition at line 97 of file CommSettings.cpp.

boost::asio::ip::address_v4 sick::datastructure::CommSettings::getSensorIp ( ) const

Gets the sensor IP-address.

Returns: The sensor IP-address.

Definition at line 151 of file CommSettings.cpp.

uint16_t sick::datastructure::CommSettings::getSensorTcpPort ( ) const

Gets the sensor tcp port.

Returns: The sensor tcp port.

Definition at line 166 of file CommSettings.cpp.

uint32_t sick::datastructure::CommSettings::getStartAngle ( ) const

Gets the start angle of the scan.

Returns: The start angle of the scan.

Definition at line 107 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setChannel ( const uint8_t & channel )

Sets the channel of the data.

Parameters

channel The new channel.

Definition at line 72 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setEInterfaceType ( const uint8_t & e_interface_type )

Sets the eInterface type.

Parameters

e_interface_type The new eInterface type.

Definition at line 92 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setEnabled ( bool enabled )

Sets if the channel is enabled.

Parameters

enabled If the channel is enabled.

Definition at line 82 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setEndAngle ( const uint32_t & end_angle )

Sets the end angle of the scan.

Parameters

end_angle The end angle of the scan.

Definition at line 122 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setFeatures ( const uint16_t & features )

Set the enabled features.

Parameters

features The new enabled features.

Definition at line 132 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setFeatures	(	const bool	general_system_state,
		const bool	derived_settings,
		const bool	measurement_data,
		const bool	intrusion_data,
		const bool	application_data
	)

Sets the enabled features.

Parameters

general_system_state	If general system state is enabled.
derived_settings	If derived settings are enabled.
measurement_data	If the measurement data is enabled.
intrusion_data	If intrusion data is enabled.
application_data	If application data is enabled.

Definition at line 137 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setHostIp ( const boost::asio::ip::address_v4 & host_ip )

Sets the IP-address of the host from an IP-address.

Parameters

host_ip The new host IP-address.

Definition at line 47 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setHostIp ( const std::string & host_ip )

Sets the IP-address of the host from a string.

Parameters

host_ip The new host IP-address.

Definition at line 52 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setHostUdpPort ( const uint16_t & host_udp_port )

Sets the host udp port.

Parameters

host_udp_port The new host udp port.

Definition at line 62 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setPublishingFrequency ( const uint16_t & publishing_frequency )

Sets the publishing frequency.

Parameters

publishing_frequency The publishing frequency.

Definition at line 102 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setSensorIp ( const boost::asio::ip::address_v4 & sensor_ip )

Sets the sensor IP-address.

Parameters

sensor_ip The sensor IP-address.

Definition at line 156 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setSensorIp ( const std::string & sensor_ip )

Sets the sensor IP-address from a string.

Parameters

sensor_ip Sets the sensor IP-address.

Definition at line 161 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setSensorTcpPort ( const uint16_t & sensor_tcp_port )

Sets the sensor tcp port.

Parameters

sensor_tcp_portThe sensor tcp port.

Definition at line 171 of file CommSettings.cpp.

void sick::datastructure::CommSettings::setStartAngle ( const uint32_t & start_angle )

Sets the start angle of the scan.

Parameters

start_angle The start angle of the scan.

Definition at line 112 of file CommSettings.cpp.

Member Data Documentation

uint8_t sick::datastructure::CommSettings::m_channel

private

Definition at line 230 of file CommSettings.h.

uint8_t sick::datastructure::CommSettings::m_e_interface_type

private

Definition at line 232 of file CommSettings.h.

bool sick::datastructure::CommSettings::m_enabled

private

Definition at line 231 of file CommSettings.h.

uint32_t sick::datastructure::CommSettings::m_end_angle

private

Definition at line 235 of file CommSettings.h.

uint16_t sick::datastructure::CommSettings::m_features

private

Definition at line 236 of file CommSettings.h.

boost::asio::ip::address_v4 sick::datastructure::CommSettings::m_host_ip

private

Definition at line 228 of file CommSettings.h.

uint16_t sick::datastructure::CommSettings::m_host_udp_port

private

Definition at line 229 of file CommSettings.h.

uint16_t sick::datastructure::CommSettings::m_publishing_frequency

private

Definition at line 233 of file CommSettings.h.

boost::asio::ip::address_v4 sick::datastructure::CommSettings::m_sensor_ip

private

Definition at line 226 of file CommSettings.h.

uint16_t sick::datastructure::CommSettings::m_sensor_tcp_port

private

Definition at line 227 of file CommSettings.h.

uint32_t sick::datastructure::CommSettings::m_start_angle

private

Definition at line 234 of file CommSettings.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation