CommSettings.h
Go to the documentation of this file.
1 // this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-
2 
3 // -- BEGIN LICENSE BLOCK ----------------------------------------------
4 
24 // -- END LICENSE BLOCK ------------------------------------------------
25 
26 //----------------------------------------------------------------------
33 //----------------------------------------------------------------------
34 
35 #ifndef SICK_SAFETYSCANNERS_DATASTRUCTURE_COMMSETTINGS_H
36 #define SICK_SAFETYSCANNERS_DATASTRUCTURE_COMMSETTINGS_H
37 
38 #include <boost/asio/ip/address_v4.hpp>
39 #include <iostream>
40 #include <string>
41 
42 namespace sick {
43 namespace datastructure {
44 
49 {
50 public:
54  CommSettings();
55 
61  boost::asio::ip::address_v4 getHostIp() const;
67  void setHostIp(const boost::asio::ip::address_v4& host_ip);
73  void setHostIp(const std::string& host_ip);
74 
80  uint16_t getHostUdpPort() const;
86  void setHostUdpPort(const uint16_t& host_udp_port);
87 
93  uint8_t getChannel() const;
99  void setChannel(const uint8_t& channel);
100 
106  bool getEnabled() const;
112  void setEnabled(bool enabled);
113 
119  uint8_t getEInterfaceType() const;
125  void setEInterfaceType(const uint8_t& e_interface_type);
126 
132  uint16_t getPublishingFrequency() const;
138  void setPublishingFrequency(const uint16_t& publishing_frequency);
139 
145  int32_t getStartAngle() const;
151  void setStartAngle(const int32_t& start_angle);
152 
158  int32_t getEndAngle() const;
164  void setEndAngle(const int32_t& end_angle);
165 
171  uint16_t getFeatures() const;
177  void setFeatures(const uint16_t& features);
187  void setFeatures(bool general_system_state,
188  bool derived_settings,
189  bool measurement_data,
190  bool intrusion_data,
191  bool application_data);
192 
198  boost::asio::ip::address_v4 getSensorIp() const;
204  void setSensorIp(const boost::asio::ip::address_v4& sensor_ip);
205 
211  uint16_t getSensorTcpPort() const;
217  void setSensorTcpPort(const uint16_t& sensor_tcp_port);
223  void setSensorIp(const std::string& sensor_ip);
224 
225 private:
226  boost::asio::ip::address_v4 m_sensor_ip;
228  boost::asio::ip::address_v4 m_host_ip;
229  uint16_t m_host_udp_port;
230  uint8_t m_channel;
231  bool m_enabled;
234  int32_t m_start_angle;
235  int32_t m_end_angle;
236  uint16_t m_features;
237 };
238 
239 
240 } // namespace datastructure
241 } // namespace sick
242 
243 #endif // SICK_SAFETYSCANNERS_DATASTRUCTURE_COMMSETTINGS_H
sick::datastructure::CommSettings::getFeatures
uint16_t getFeatures() const
Gets the enabled features.
Definition: CommSettings.cpp:127
sick::datastructure::CommSettings::getPublishingFrequency
uint16_t getPublishingFrequency() const
Gets the publishing frequency.
Definition: CommSettings.cpp:97
sick::datastructure::CommSettings::setHostIp
void setHostIp(const boost::asio::ip::address_v4 &host_ip)
Sets the IP-address of the host from an IP-address.
Definition: CommSettings.cpp:47
sick
Definition: ApplicationNameVariableCommand.h:43
sick::datastructure::CommSettings::m_channel
uint8_t m_channel
Definition: CommSettings.h:230
sick::datastructure::CommSettings
Containing the communication settings for the sensor which can be changed on runtime.
Definition: CommSettings.h:48
sick::datastructure::CommSettings::setHostUdpPort
void setHostUdpPort(const uint16_t &host_udp_port)
Sets the host udp port.
Definition: CommSettings.cpp:62
sick::datastructure::CommSettings::getEnabled
bool getEnabled() const
Gets if the channel is enabled.
Definition: CommSettings.cpp:77
sick::datastructure::CommSettings::setFeatures
void setFeatures(const uint16_t &features)
Set the enabled features.
Definition: CommSettings.cpp:132
sick::datastructure::CommSettings::m_sensor_ip
boost::asio::ip::address_v4 m_sensor_ip
Definition: CommSettings.h:226
sick::datastructure::e_interface_type
e_interface_type
Definition: TypeCode.h:44
sick::datastructure::CommSettings::setEInterfaceType
void setEInterfaceType(const uint8_t &e_interface_type)
Sets the eInterface type.
Definition: CommSettings.cpp:92
sick::datastructure::CommSettings::setPublishingFrequency
void setPublishingFrequency(const uint16_t &publishing_frequency)
Sets the publishing frequency.
Definition: CommSettings.cpp:102
sick::datastructure::CommSettings::getHostUdpPort
uint16_t getHostUdpPort() const
Gets the host udp port.
Definition: CommSettings.cpp:57
sick::datastructure::CommSettings::getEndAngle
int32_t getEndAngle() const
Gets the end angle of the scan.
Definition: CommSettings.cpp:117
sick::datastructure::CommSettings::m_start_angle
int32_t m_start_angle
Definition: CommSettings.h:234
sick::datastructure::CommSettings::m_end_angle
int32_t m_end_angle
Definition: CommSettings.h:235
sick::datastructure::CommSettings::getSensorTcpPort
uint16_t getSensorTcpPort() const
Gets the sensor tcp port.
Definition: CommSettings.cpp:166
sick::datastructure::CommSettings::m_host_udp_port
uint16_t m_host_udp_port
Definition: CommSettings.h:229
sick::datastructure::CommSettings::m_features
uint16_t m_features
Definition: CommSettings.h:236
sick::datastructure::CommSettings::setSensorIp
void setSensorIp(const boost::asio::ip::address_v4 &sensor_ip)
Sets the sensor IP-address.
Definition: CommSettings.cpp:156
sick::datastructure::CommSettings::setStartAngle
void setStartAngle(const int32_t &start_angle)
Sets the start angle of the scan.
Definition: CommSettings.cpp:112
sick::datastructure::CommSettings::setEnabled
void setEnabled(bool enabled)
Sets if the channel is enabled.
Definition: CommSettings.cpp:82
sick::datastructure::CommSettings::m_sensor_tcp_port
uint16_t m_sensor_tcp_port
Definition: CommSettings.h:227
sick::datastructure::CommSettings::m_enabled
bool m_enabled
Definition: CommSettings.h:231
sick::datastructure::CommSettings::setChannel
void setChannel(const uint8_t &channel)
Sets the channel of the data.
Definition: CommSettings.cpp:72
sick::datastructure::CommSettings::m_e_interface_type
uint8_t m_e_interface_type
Definition: CommSettings.h:232
sick::datastructure::CommSettings::getEInterfaceType
uint8_t getEInterfaceType() const
Gets the eInterface type.
Definition: CommSettings.cpp:87
sick::datastructure::CommSettings::getChannel
uint8_t getChannel() const
Gets the channel of the data.
Definition: CommSettings.cpp:67
sick::datastructure::CommSettings::getHostIp
boost::asio::ip::address_v4 getHostIp() const
Gets the IP-address of the host.
Definition: CommSettings.cpp:42
sick::datastructure::CommSettings::m_host_ip
boost::asio::ip::address_v4 m_host_ip
Definition: CommSettings.h:228
sick::datastructure::CommSettings::setSensorTcpPort
void setSensorTcpPort(const uint16_t &sensor_tcp_port)
Sets the sensor tcp port.
Definition: CommSettings.cpp:171
sick::datastructure::CommSettings::m_publishing_frequency
uint16_t m_publishing_frequency
Definition: CommSettings.h:233
sick::datastructure::CommSettings::setEndAngle
void setEndAngle(const int32_t &end_angle)
Sets the end angle of the scan.
Definition: CommSettings.cpp:122
sick::datastructure::CommSettings::CommSettings
CommSettings()
Constructor of the communication settings.
Definition: CommSettings.cpp:40
sick::datastructure::CommSettings::getSensorIp
boost::asio::ip::address_v4 getSensorIp() const
Gets the sensor IP-address.
Definition: CommSettings.cpp:151
sick::datastructure::CommSettings::getStartAngle
int32_t getStartAngle() const
Gets the start angle of the scan.
Definition: CommSettings.cpp:107


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Fri Jun 21 2024 02:40:51