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.
uint8_t	getChannel () const
	Gets the channel of the data.
uint8_t	getEInterfaceType () const
	Gets the eInterface type.
bool	getEnabled () const
	Gets if the channel is enabled.
uint32_t	getEndAngle () const
	Gets the end angle of the scan.
uint16_t	getFeatures () const
	Gets the enabled features.
boost::asio::ip::address_v4	getHostIp () const
	Gets the IP-address of the host.
uint16_t	getHostUdpPort () const
	Gets the host udp port.
uint16_t	getPublishingFrequency () const
	Gets the publishing frequency.
boost::asio::ip::address_v4	getSensorIp () const
	Gets the sensor IP-address.
uint16_t	getSensorTcpPort () const
	Gets the sensor tcp port.
uint32_t	getStartAngle () const
	Gets the start angle of the scan.
void	setChannel (const uint8_t &channel)
	Sets the channel of the data.
void	setEInterfaceType (const uint8_t &e_interface_type)
	Sets the eInterface type.
void	setEnabled (bool enabled)
	Sets if the channel is enabled.
void	setEndAngle (const uint32_t &end_angle)
	Sets the end angle of the scan.
void	setFeatures (const uint16_t &features)
	Set the enabled features.
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.
void	setHostIp (const boost::asio::ip::address_v4 &host_ip)
	Sets the IP-address of the host from an IP-address.
void	setHostIp (const std::string &host_ip)
	Sets the IP-address of the host from a string.
void	setHostUdpPort (const uint16_t &host_udp_port)
	Sets the host udp port.
void	setPublishingFrequency (const uint16_t &publishing_frequency)
	Sets the publishing frequency.
void	setSensorIp (const boost::asio::ip::address_v4 &sensor_ip)
	Sets the sensor IP-address.
void	setSensorIp (const std::string &sensor_ip)
	Sets the sensor IP-address from a string.
void	setSensorTcpPort (const uint16_t &sensor_tcp_port)
	Sets the sensor tcp port.
void	setStartAngle (const uint32_t &start_angle)
	Sets the start angle of the scan.
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.