From 5648f301be4f78d61c9be47030f60834be0b2636 Mon Sep 17 00:00:00 2001 From: flipflip Date: Mon, 13 Jan 2025 07:56:27 +0100 Subject: [PATCH 01/34] Use Fixposition SDK, add devcontainer config, general cleanup --- .devcontainer/.bash_history.d/.gitkeep | 0 .devcontainer/.bash_logout | 9 + .devcontainer/.bashrc | 173 ++ .devcontainer/.dummy-dir/.gitkeep | 0 .devcontainer/.dummy-file | 0 .devcontainer/.gitignore | 2 + .devcontainer/.vscode-server/.gitkeep | 0 .devcontainer/helper.sh | 35 + .devcontainer/humble/Dockerfile | 12 + .devcontainer/humble/devcontainer.json | 53 + .devcontainer/jazzy/Dockerfile | 12 + .devcontainer/jazzy/devcontainer.json | 52 + .devcontainer/noetic/Dockerfile | 12 + .devcontainer/noetic/devcontainer.json | 52 + .github/ci.sh | 162 ++ .github/workflows/build_test_ros.yml | 43 - .github/workflows/build_test_ros2.yml | 43 - .github/workflows/ci.yml | 64 + .gitignore | 16 +- .gitmodules | 4 + .pre-commit-config.yaml | 15 + LICENSE | 2 +- README.md | 18 +- create_ros_ws.sh | 213 ++ fixposition-sdk | 1 + fixposition_driver.code-workspace | 237 ++ fixposition_driver_lib/CMakeLists.txt | 57 +- fixposition_driver_lib/Doxyfile | 2427 ----------------- fixposition_driver_lib/README.md | 36 +- .../fixposition_driver.hpp | 255 +- .../fixposition_driver_lib/gnss_tf.hpp | 164 -- .../include/fixposition_driver_lib/helper.hpp | 277 +- .../messages/base_converter.hpp | 268 -- .../messages/fpa_type.hpp | 644 ----- .../messages/fpb_measurements.hpp | 73 - .../messages/fpb_type.hpp | 92 - .../messages/msg_data.hpp | 190 -- .../messages/nmea_type.hpp | 567 ---- .../messages/nov_type.hpp | 711 ----- .../include/fixposition_driver_lib/params.hpp | 74 +- .../include/fixposition_driver_lib/parser.hpp | 43 - .../time_conversions.hpp | 271 -- fixposition_driver_lib/package.xml | 13 +- .../src/fixposition_driver.cpp | 882 +++--- fixposition_driver_lib/src/gnss_tf.cpp | 197 -- fixposition_driver_lib/src/helper.cpp | 359 ++- .../src/messages/fpa/corrimu.cpp | 63 - .../src/messages/fpa/eoe.cpp | 57 - .../src/messages/fpa/gnssant.cpp | 67 - .../src/messages/fpa/gnsscorr.cpp | 85 - .../src/messages/fpa/imubias.cpp | 80 - .../src/messages/fpa/llh.cpp | 70 - .../src/messages/fpa/odomenu.cpp | 139 - .../src/messages/fpa/odometry.cpp | 141 - .../src/messages/fpa/odomsh.cpp | 139 - .../src/messages/fpa/odomstatus.cpp | 111 - .../src/messages/fpa/rawimu.cpp | 63 - .../src/messages/fpa/text.cpp | 54 - .../src/messages/fpa/tf.cpp | 74 - .../src/messages/fpa/tp.cpp | 62 - .../src/messages/nmea/gngsa.cpp | 64 - .../src/messages/nmea/gpgga.cpp | 96 - .../src/messages/nmea/gpgll.cpp | 67 - .../src/messages/nmea/gpgst.cpp | 55 - .../src/messages/nmea/gphdt.cpp | 39 - .../src/messages/nmea/gprmc.cpp | 81 - .../src/messages/nmea/gpvtg.cpp | 57 - .../src/messages/nmea/gpzda.cpp | 62 - .../src/messages/nmea/gxgsv.cpp | 61 - .../src/messages/nmea/nmea.cpp | 155 -- fixposition_driver_lib/src/params.cpp | 46 + fixposition_driver_lib/src/parser.cpp | 139 - fixposition_driver_msgs/CMakeLists.txt | 149 + fixposition_driver_msgs/README.md | 3 + .../fixposition_driver_msgs/data_to_ros.hpp | 661 +++++ fixposition_driver_msgs/msg/CovWarn.msg | 8 + fixposition_driver_msgs/msg/FpaConsts.msg | 198 ++ fixposition_driver_msgs/msg/FpaEoe.msg | 9 + fixposition_driver_msgs/msg/FpaGnssant.msg | 14 + fixposition_driver_msgs/msg/FpaGnsscorr.msg | 23 + fixposition_driver_msgs/msg/FpaImubias.msg | 16 + fixposition_driver_msgs/msg/FpaLlh.msg | 10 + fixposition_driver_msgs/msg/FpaOdomenu.msg | 19 + fixposition_driver_msgs/msg/FpaOdometry.msg | 21 + fixposition_driver_msgs/msg/FpaOdomsh.msg | 19 + fixposition_driver_msgs/msg/FpaOdomstatus.msg | 28 + fixposition_driver_msgs/msg/FpaText.msg | 10 + fixposition_driver_msgs/msg/FpaTp.msg | 14 + fixposition_driver_msgs/msg/NmeaConsts.msg | 105 + fixposition_driver_msgs/msg/NmeaEpoch.msg | 64 + fixposition_driver_msgs/msg/NmeaGga.msg | 25 + fixposition_driver_msgs/msg/NmeaGll.msg | 19 + fixposition_driver_msgs/msg/NmeaGsa.msg | 18 + fixposition_driver_msgs/msg/NmeaGst.msg | 21 + fixposition_driver_msgs/msg/NmeaGsv.msg | 20 + fixposition_driver_msgs/msg/NmeaHdt.msg | 10 + fixposition_driver_msgs/msg/NmeaRmc.msg | 29 + fixposition_driver_msgs/msg/NmeaSatellite.msg | 11 + fixposition_driver_msgs/msg/NmeaSignal.msg | 12 + fixposition_driver_msgs/msg/NmeaVtg.msg | 15 + fixposition_driver_msgs/msg/NmeaZda.msg | 21 + fixposition_driver_msgs/msg/ParserMsg.msg | 23 + fixposition_driver_msgs/msg/Speed.msg | 7 + fixposition_driver_msgs/msg/WheelSensor.msg | 20 + fixposition_driver_msgs/package.xml | 35 + fixposition_driver_msgs/src/data_to_ros.cpp | 25 + fixposition_driver_ros1/CMakeLists.txt | 70 +- fixposition_driver_ros1/Doxyfile | 2427 ----------------- fixposition_driver_ros1/README.md | 18 +- .../fixposition_driver_ros1/data_to_ros1.hpp | 201 +- .../fixposition_driver_node.hpp | 196 +- .../fixposition_driver_ros1/params.hpp | 59 +- .../fixposition_driver_ros1/ros1_msgs.hpp | 57 + .../fixposition_driver_ros1/ros_msgs.hpp | 66 - fixposition_driver_ros1/launch/config.yaml | 58 + fixposition_driver_ros1/launch/dev.launch | 9 + .../launch/driver_with_odom_converter.launch | 4 +- fixposition_driver_ros1/launch/node.launch | 9 + .../launch/rosconsole.conf | 4 +- .../launch/rosconsole_dev.conf | 2 + fixposition_driver_ros1/launch/serial.launch | 16 - fixposition_driver_ros1/launch/serial.yaml | 17 - fixposition_driver_ros1/launch/tcp.launch | 16 - fixposition_driver_ros1/launch/tcp.yaml | 17 - fixposition_driver_ros1/msg/GnssSats.msg | 23 - fixposition_driver_ros1/msg/NMEA.msg | 65 - fixposition_driver_ros1/msg/Speed.msg | 17 - fixposition_driver_ros1/msg/WheelSensor.msg | 29 - .../msg/extras/CovWarn.msg | 18 - fixposition_driver_ros1/msg/fpa/eoe.msg | 17 - fixposition_driver_ros1/msg/fpa/gnssant.msg | 22 - fixposition_driver_ros1/msg/fpa/gnsscorr.msg | 31 - fixposition_driver_ros1/msg/fpa/imubias.msg | 71 - fixposition_driver_ros1/msg/fpa/llh.msg | 19 - fixposition_driver_ros1/msg/fpa/odomenu.msg | 27 - fixposition_driver_ros1/msg/fpa/odometry.msg | 28 - fixposition_driver_ros1/msg/fpa/odomsh.msg | 27 - .../msg/fpa/odomstatus.msg | 190 -- fixposition_driver_ros1/msg/fpa/text.msg | 18 - fixposition_driver_ros1/msg/fpa/tp.msg | 56 - fixposition_driver_ros1/msg/nmea/gngsa.msg | 24 - fixposition_driver_ros1/msg/nmea/gpgga.msg | 40 - fixposition_driver_ros1/msg/nmea/gpgll.msg | 35 - fixposition_driver_ros1/msg/nmea/gpgst.msg | 25 - fixposition_driver_ros1/msg/nmea/gphdt.msg | 19 - fixposition_driver_ros1/msg/nmea/gprmc.msg | 38 - fixposition_driver_ros1/msg/nmea/gpvtg.msg | 37 - fixposition_driver_ros1/msg/nmea/gpzda.msg | 22 - fixposition_driver_ros1/msg/nmea/gxgsv.msg | 39 - fixposition_driver_ros1/package.xml | 12 +- fixposition_driver_ros1/src/data_to_ros1.cpp | 1185 ++++---- .../src/fixposition_driver_node.cpp | 1011 ++++--- fixposition_driver_ros1/src/params.cpp | 172 +- fixposition_driver_ros2/CMakeLists.txt | 58 +- fixposition_driver_ros2/Doxyfile | 2427 ----------------- fixposition_driver_ros2/README.md | 18 +- .../fixposition_driver_ros2/data_to_ros2.hpp | 153 +- .../fixposition_driver_node.hpp | 223 +- .../fixposition_driver_ros2/params.hpp | 65 +- .../fixposition_driver_ros2/ros2_msgs.hpp | 104 +- fixposition_driver_ros2/launch/config.yaml | 61 + fixposition_driver_ros2/launch/dev.launch | 12 + fixposition_driver_ros2/launch/node.launch | 12 + fixposition_driver_ros2/launch/serial.launch | 11 - fixposition_driver_ros2/launch/serial.yaml | 19 - fixposition_driver_ros2/launch/tcp.launch | 12 - fixposition_driver_ros2/launch/tcp.yaml | 20 - fixposition_driver_ros2/msg/Gnsssats.msg | 20 - fixposition_driver_ros2/msg/NMEA.msg | 63 - fixposition_driver_ros2/msg/Speed.msg | 14 - fixposition_driver_ros2/msg/WheelSensor.msg | 26 - .../msg/extras/COVWARN.msg | 15 - fixposition_driver_ros2/msg/fpa/EOE.msg | 14 - fixposition_driver_ros2/msg/fpa/GNSSANT.msg | 19 - fixposition_driver_ros2/msg/fpa/GNSSCORR.msg | 28 - fixposition_driver_ros2/msg/fpa/IMUBIAS.msg | 68 - fixposition_driver_ros2/msg/fpa/LLH.msg | 16 - fixposition_driver_ros2/msg/fpa/ODOMENU.msg | 24 - fixposition_driver_ros2/msg/fpa/ODOMETRY.msg | 25 - fixposition_driver_ros2/msg/fpa/ODOMSH.msg | 24 - .../msg/fpa/ODOMSTATUS.msg | 187 -- fixposition_driver_ros2/msg/fpa/TEXT.msg | 15 - fixposition_driver_ros2/msg/fpa/TP.msg | 53 - fixposition_driver_ros2/msg/nmea/GNGSA.msg | 21 - fixposition_driver_ros2/msg/nmea/GPGGA.msg | 37 - fixposition_driver_ros2/msg/nmea/GPGLL.msg | 32 - fixposition_driver_ros2/msg/nmea/GPGST.msg | 22 - fixposition_driver_ros2/msg/nmea/GPHDT.msg | 16 - fixposition_driver_ros2/msg/nmea/GPRMC.msg | 35 - fixposition_driver_ros2/msg/nmea/GPVTG.msg | 34 - fixposition_driver_ros2/msg/nmea/GPZDA.msg | 19 - fixposition_driver_ros2/msg/nmea/GXGSV.msg | 36 - fixposition_driver_ros2/package.xml | 11 +- fixposition_driver_ros2/src/data_to_ros2.cpp | 1206 ++++---- .../src/fixposition_driver_node.cpp | 1073 +++++--- fixposition_driver_ros2/src/params.cpp | 197 +- .../CMakeLists.txt | 2 +- fixposition_odometry_converter_ros1/README.md | 21 +- .../odom_converter.hpp | 32 +- .../params.hpp | 30 +- .../ros_msgs.hpp | 21 +- .../package.xml | 10 +- .../src/odom_converter.cpp | 30 +- .../src/odom_converter_node.cpp | 21 +- .../src/params.cpp | 26 +- .../CMakeLists.txt | 4 +- fixposition_odometry_converter_ros2/README.md | 21 +- .../odom_converter_node.hpp | 34 +- .../params.hpp | 32 +- .../ros2_msgs.hpp | 15 +- .../package.xml | 30 +- .../src/odom_converter_node.cpp | 33 +- .../src/params.cpp | 25 +- precommit.sh | 8 + 214 files changed, 7646 insertions(+), 18496 deletions(-) create mode 100644 .devcontainer/.bash_history.d/.gitkeep create mode 100644 .devcontainer/.bash_logout create mode 100644 .devcontainer/.bashrc create mode 100644 .devcontainer/.dummy-dir/.gitkeep create mode 100644 .devcontainer/.dummy-file create mode 100644 .devcontainer/.gitignore create mode 100644 .devcontainer/.vscode-server/.gitkeep create mode 100755 .devcontainer/helper.sh create mode 100644 .devcontainer/humble/Dockerfile create mode 100644 .devcontainer/humble/devcontainer.json create mode 100644 .devcontainer/jazzy/Dockerfile create mode 100644 .devcontainer/jazzy/devcontainer.json create mode 100644 .devcontainer/noetic/Dockerfile create mode 100644 .devcontainer/noetic/devcontainer.json create mode 100755 .github/ci.sh delete mode 100644 .github/workflows/build_test_ros.yml delete mode 100644 .github/workflows/build_test_ros2.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .gitmodules create mode 100644 .pre-commit-config.yaml create mode 100755 create_ros_ws.sh create mode 160000 fixposition-sdk create mode 100644 fixposition_driver.code-workspace delete mode 100644 fixposition_driver_lib/Doxyfile delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/gnss_tf.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/base_converter.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/fpa_type.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/fpb_measurements.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/fpb_type.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/msg_data.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/nmea_type.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/messages/nov_type.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/parser.hpp delete mode 100644 fixposition_driver_lib/include/fixposition_driver_lib/time_conversions.hpp delete mode 100644 fixposition_driver_lib/src/gnss_tf.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/corrimu.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/eoe.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/gnssant.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/gnsscorr.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/imubias.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/llh.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/odomenu.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/odometry.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/odomsh.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/odomstatus.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/rawimu.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/text.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/tf.cpp delete mode 100644 fixposition_driver_lib/src/messages/fpa/tp.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gngsa.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gpgga.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gpgll.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gpgst.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gphdt.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gprmc.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gpvtg.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gpzda.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/gxgsv.cpp delete mode 100644 fixposition_driver_lib/src/messages/nmea/nmea.cpp create mode 100644 fixposition_driver_lib/src/params.cpp delete mode 100644 fixposition_driver_lib/src/parser.cpp create mode 100644 fixposition_driver_msgs/CMakeLists.txt create mode 100644 fixposition_driver_msgs/README.md create mode 100644 fixposition_driver_msgs/include/fixposition_driver_msgs/data_to_ros.hpp create mode 100644 fixposition_driver_msgs/msg/CovWarn.msg create mode 100644 fixposition_driver_msgs/msg/FpaConsts.msg create mode 100644 fixposition_driver_msgs/msg/FpaEoe.msg create mode 100644 fixposition_driver_msgs/msg/FpaGnssant.msg create mode 100644 fixposition_driver_msgs/msg/FpaGnsscorr.msg create mode 100644 fixposition_driver_msgs/msg/FpaImubias.msg create mode 100644 fixposition_driver_msgs/msg/FpaLlh.msg create mode 100644 fixposition_driver_msgs/msg/FpaOdomenu.msg create mode 100644 fixposition_driver_msgs/msg/FpaOdometry.msg create mode 100644 fixposition_driver_msgs/msg/FpaOdomsh.msg create mode 100644 fixposition_driver_msgs/msg/FpaOdomstatus.msg create mode 100644 fixposition_driver_msgs/msg/FpaText.msg create mode 100644 fixposition_driver_msgs/msg/FpaTp.msg create mode 100644 fixposition_driver_msgs/msg/NmeaConsts.msg create mode 100644 fixposition_driver_msgs/msg/NmeaEpoch.msg create mode 100644 fixposition_driver_msgs/msg/NmeaGga.msg create mode 100644 fixposition_driver_msgs/msg/NmeaGll.msg create mode 100644 fixposition_driver_msgs/msg/NmeaGsa.msg create mode 100644 fixposition_driver_msgs/msg/NmeaGst.msg create mode 100644 fixposition_driver_msgs/msg/NmeaGsv.msg create mode 100644 fixposition_driver_msgs/msg/NmeaHdt.msg create mode 100644 fixposition_driver_msgs/msg/NmeaRmc.msg create mode 100644 fixposition_driver_msgs/msg/NmeaSatellite.msg create mode 100644 fixposition_driver_msgs/msg/NmeaSignal.msg create mode 100644 fixposition_driver_msgs/msg/NmeaVtg.msg create mode 100644 fixposition_driver_msgs/msg/NmeaZda.msg create mode 100644 fixposition_driver_msgs/msg/ParserMsg.msg create mode 100644 fixposition_driver_msgs/msg/Speed.msg create mode 100644 fixposition_driver_msgs/msg/WheelSensor.msg create mode 100644 fixposition_driver_msgs/package.xml create mode 100644 fixposition_driver_msgs/src/data_to_ros.cpp delete mode 100644 fixposition_driver_ros1/Doxyfile create mode 100644 fixposition_driver_ros1/include/fixposition_driver_ros1/ros1_msgs.hpp delete mode 100644 fixposition_driver_ros1/include/fixposition_driver_ros1/ros_msgs.hpp create mode 100644 fixposition_driver_ros1/launch/config.yaml create mode 100644 fixposition_driver_ros1/launch/dev.launch create mode 100644 fixposition_driver_ros1/launch/node.launch create mode 100644 fixposition_driver_ros1/launch/rosconsole_dev.conf delete mode 100644 fixposition_driver_ros1/launch/serial.launch delete mode 100644 fixposition_driver_ros1/launch/serial.yaml delete mode 100644 fixposition_driver_ros1/launch/tcp.launch delete mode 100644 fixposition_driver_ros1/launch/tcp.yaml delete mode 100644 fixposition_driver_ros1/msg/GnssSats.msg delete mode 100644 fixposition_driver_ros1/msg/NMEA.msg delete mode 100644 fixposition_driver_ros1/msg/Speed.msg delete mode 100644 fixposition_driver_ros1/msg/WheelSensor.msg delete mode 100644 fixposition_driver_ros1/msg/extras/CovWarn.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/eoe.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/gnssant.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/gnsscorr.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/imubias.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/llh.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/odomenu.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/odometry.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/odomsh.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/odomstatus.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/text.msg delete mode 100644 fixposition_driver_ros1/msg/fpa/tp.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gngsa.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gpgga.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gpgll.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gpgst.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gphdt.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gprmc.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gpvtg.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gpzda.msg delete mode 100644 fixposition_driver_ros1/msg/nmea/gxgsv.msg delete mode 100644 fixposition_driver_ros2/Doxyfile create mode 100644 fixposition_driver_ros2/launch/config.yaml create mode 100644 fixposition_driver_ros2/launch/dev.launch create mode 100644 fixposition_driver_ros2/launch/node.launch delete mode 100644 fixposition_driver_ros2/launch/serial.launch delete mode 100644 fixposition_driver_ros2/launch/serial.yaml delete mode 100644 fixposition_driver_ros2/launch/tcp.launch delete mode 100644 fixposition_driver_ros2/launch/tcp.yaml delete mode 100644 fixposition_driver_ros2/msg/Gnsssats.msg delete mode 100644 fixposition_driver_ros2/msg/NMEA.msg delete mode 100644 fixposition_driver_ros2/msg/Speed.msg delete mode 100644 fixposition_driver_ros2/msg/WheelSensor.msg delete mode 100644 fixposition_driver_ros2/msg/extras/COVWARN.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/EOE.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/GNSSANT.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/GNSSCORR.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/IMUBIAS.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/LLH.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/ODOMENU.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/ODOMETRY.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/ODOMSH.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/ODOMSTATUS.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/TEXT.msg delete mode 100644 fixposition_driver_ros2/msg/fpa/TP.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GNGSA.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPGGA.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPGLL.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPGST.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPHDT.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPRMC.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPVTG.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GPZDA.msg delete mode 100644 fixposition_driver_ros2/msg/nmea/GXGSV.msg create mode 100755 precommit.sh diff --git a/.devcontainer/.bash_history.d/.gitkeep b/.devcontainer/.bash_history.d/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/.devcontainer/.bash_logout b/.devcontainer/.bash_logout new file mode 100644 index 00000000..9265fd43 --- /dev/null +++ b/.devcontainer/.bash_logout @@ -0,0 +1,9 @@ +# ~/.bash_logout: executed by bash(1) when login shell exits. + +# save history +history -a + +# when leaving the console clear the screen to increase privacy +if [ "$SHLVL" = 1 ]; then + [ -x /usr/bin/clear_console ] && /usr/bin/clear_console -q +fi diff --git a/.devcontainer/.bashrc b/.devcontainer/.bashrc new file mode 100644 index 00000000..e602d262 --- /dev/null +++ b/.devcontainer/.bashrc @@ -0,0 +1,173 @@ +# ~/.bashrc: executed by bash(1) for non-login shells. +# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc) +# for examples + +# If not running interactively, don't do anything +case $- in + *i*) ;; + *) return;; +esac + +# don't put duplicate lines or lines starting with space in the history. +# See bash(1) for more options +HISTCONTROL="ignoredups:erasedups:ignorespace" + +# append to the history file, don't overwrite it +shopt -s histappend + +# for setting history length see HISTSIZE and HISTFILESIZE in bash(1) +HISTSIZE=10000 +HISTFILESIZE=10000000 +HISTFILE=/home/fpsdk/.bash_history.d/history + +# Disable history ! expansion +set +H + +export RSYNC_RSH=ssh +export PAGER="less -R -i -x 4 -+C" +export PERLDOC_PAGER="less -R -i -x 4 -+C" +export LESSCHARSET=UTF-8 +export EDITOR='vim' +export GIT_EDITOR=vim + +# nicely coloured man pages +export LESS_TERMCAP_mb=$'\E[01;31m' +export LESS_TERMCAP_md=$'\E[01;31m' +export LESS_TERMCAP_me=$'\E[0m' +export LESS_TERMCAP_se=$'\E[0m' +export LESS_TERMCAP_so=$'\E[01;44;33m' +export LESS_TERMCAP_ue=$'\E[0m' +export LESS_TERMCAP_us=$'\E[01;32m' + +export LESS="FRSX" + +# N.B. -R must be first or lesspipe.sh will be confused +# warning: -R not compatible with +F (follow mode)! +alias less='less -R -i -x 4 -S' + +# Enable core dumps (does it?) +ulimit -c 1048576 + +# check the window size after each command and, if necessary, +# update the values of LINES and COLUMNS. +shopt -s checkwinsize + +# If set, the pattern "**" used in a pathname expansion context will +# match all files and zero or more directories and subdirectories. +#shopt -s globstar + +# make less more friendly for non-text input files, see lesspipe(1) +[ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)" + +# set variable identifying the chroot you work in (used in the prompt below) +if [ -z "${debian_chroot:-}" ] && [ -r /etc/debian_chroot ]; then + debian_chroot=$(cat /etc/debian_chroot) +fi + +# set a fancy prompt (non-color, unless we know we "want" color) +case "$TERM" in + xterm-color|*-256color) color_prompt=yes;; +esac + +# uncomment for a colored prompt, if the terminal has the capability; turned +# off by default to not distract the user: the focus in a terminal window +# should be on the output of commands, not on the prompt +#force_color_prompt=yes + +if [ -n "$force_color_prompt" ]; then + if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then + # We have color support; assume it's compliant with Ecma-48 + # (ISO/IEC-6429). (Lack of such support is extremely rare, and such + # a case would tend to support setf rather than setaf.) + color_prompt=yes + else + color_prompt= + fi +fi + +if [ "$color_prompt" = yes ]; then + PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ ' +else + PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ ' +fi +unset color_prompt force_color_prompt + +# If this is an xterm set the title to user@host:dir +case "$TERM" in +xterm*|rxvt*) + PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1" + ;; +*) + ;; +esac + +# enable color support of ls and also add handy aliases +if [ -x /usr/bin/dircolors ]; then + test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)" + alias ls='ls --color=auto' + #alias dir='dir --color=auto' + #alias vdir='vdir --color=auto' + + alias grep='grep --color=auto' + alias fgrep='fgrep --color=auto' + alias egrep='egrep --color=auto' +fi + +# colored GCC warnings and errors +#export GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01' + +# some more ls aliases +alias ll='ls -alF' +alias la='ls -A' +alias l='ls -CF' +alias rm='rm -i' +alias mv='mv -i' + +# Add an "alert" alias for long running commands. Use like so: +# sleep 10; alert +alias alert='notify-send --urgency=low -i "$([ $? = 0 ] && echo terminal || echo error)" "$(history|tail -n1|sed -e '\''s/^\s*[0-9]\+\s*//;s/[;&|]\s*alert$//'\'')"' + +# Alias definitions. +# You may want to put all your additions into a separate file like +# ~/.bash_aliases, instead of adding them here directly. +# See /usr/share/doc/bash-doc/examples in the bash-doc package. + +if [ -f ~/.bash_aliases ]; then + . ~/.bash_aliases +fi + +# enable programmable completion features (you don't need to enable +# this, if it's already enabled in /etc/bash.bashrc and /etc/profile +# sources /etc/bash.bashrc). +if ! shopt -oq posix; then + if [ -f /usr/share/bash-completion/bash_completion ]; then + . /usr/share/bash-completion/bash_completion + elif [ -f /etc/bash_completion ]; then + . /etc/bash_completion + fi +fi + +if [ -f ~/.bash-git-prompt/gitprompt.sh ]; then + # https://github.com/magicmonty/bash-git-prompt + GIT_PROMPT_THEME=fpsdk + source ~/.bash-git-prompt/gitprompt.sh +fi + +# Source ROS environment +if [ -n "${ROS_DISTRO}" ]; then + source /opt/ros/${ROS_DISTRO}/setup.bash + export ROSCONSOLE_STDOUT_LINE_BUFFERED=1 + export ROSCONSOLE_FORMAT='${severity} ${time:%Y-%m-%d %H:%M:%S.%f} ${logger} - ${message}' + # export RCUTILS_LOGGING_BUFFERED_STREAM=1 + # export RCUTILS_LOGGING_USE_STDOUT=1 + export RCUTILS_COLORIZED_OUTPUT=1 + case "${ROS_DISTRO}" in + jazzy|rolling) + export RCUTILS_CONSOLE_OUTPUT_FORMAT="{severity} {date_time_with_ms} {name} - {message}" + ;; + *) + export RCUTILS_CONSOLE_OUTPUT_FORMAT="{severity} {time} {name} - {message}" + ;; + esac + +fi diff --git a/.devcontainer/.dummy-dir/.gitkeep b/.devcontainer/.dummy-dir/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/.devcontainer/.dummy-file b/.devcontainer/.dummy-file new file mode 100644 index 00000000..e69de29b diff --git a/.devcontainer/.gitignore b/.devcontainer/.gitignore new file mode 100644 index 00000000..45409b0b --- /dev/null +++ b/.devcontainer/.gitignore @@ -0,0 +1,2 @@ +/.bash_history.d +/.vscode-server diff --git a/.devcontainer/.vscode-server/.gitkeep b/.devcontainer/.vscode-server/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/.devcontainer/helper.sh b/.devcontainer/helper.sh new file mode 100755 index 00000000..3719d3bc --- /dev/null +++ b/.devcontainer/helper.sh @@ -0,0 +1,35 @@ +#!/bin/bash +set -eEu -o pipefail + +command=$1 +shift + +case ${command} in + onCreateCommand) + containerWorkspaceFolder=$1 + # ls -la ${containerWorkspaceFolder} + # id + case ${ROS_DISTRO} in + noetic) + if [ ! -d ${containerWorkspaceFolder}/ros1_ws ]; then + ${containerWorkspaceFolder}/create_ros_ws.sh -d ros1_ws + fi + ;; + humble|jazzy) + if [ ! -d ${containerWorkspaceFolder}/ros2_ws ]; then + ${containerWorkspaceFolder}/create_ros_ws.sh -d ros2_ws + fi + ;; + *) + echo "Don't know how to create a ROS workspace for ROS_DISTRO=${ROS_DISTRO}" + exit 1 + ;; + esac + ;; + *) + echo "bad command: ${command}" + exit 1 + ;; +esac + +exit 0 diff --git a/.devcontainer/humble/Dockerfile b/.devcontainer/humble/Dockerfile new file mode 100644 index 00000000..feb4f37a --- /dev/null +++ b/.devcontainer/humble/Dockerfile @@ -0,0 +1,12 @@ +FROM ghcr.io/fixposition/fixposition-sdk:humble-dev + +# RUN <" + echo + echo " -r 1|2 -- ROS versio (default: detect from ROS_DISTRO environment variable)" + echo " -s -- Skip Fixposition SDK check" + echo " -d -- Setup for debug build (default: release)" + echo " -- Path to workspace root (absolute, or relative to ${SCRIPTDIR})" + echo + exit 0 + ;; + *) + error "Illegal option '$OPTARG'!" 1>&2 + exit 1 + ;; + esac + done + if [ ${OPTIND} -gt 1 ]; then + shift $(expr $OPTIND - 1) + fi + + # Path can be relative to script directory (= fixposition_dirver repo root) or absolute + if [ -z "${1:-}" ]; then + exit_fail "Need a path" + fi + local abspath=$1 + local relpath= + if [ "${abspath:0:1}" != "/" ]; then + relpath=${abspath} + abspath=${SCRIPTDIR}/${relpath} + fi + debug "abspath=${abspath} relpath=${relpath}" + if [ -f ${abspath} -o -d ${abspath} ]; then + exit_fail "Path ${abspath} already exists" + fi + + # Check that the Fixposition SDK is present + if [ ${checksdk} -gt 0 -a ! -d fixposition-sdk/fpsdk_common ]; then + notice "Cloning Fixposition SDK" + if ! git submodule update --init; then + error "Failed cloning Fixposition SDK. Please fix that manually." + exit 1 + fi + fi + + # Get and check for ROS version + if [ ${rosver} -eq 0 ]; then + case "${ROS_DISTRO:-}" in + noetic) + rosver=1 + ;; + humble|jazzy) + rosver=2 + ;; + esac + fi + debug "rosver=${rosver}" + if ! [ ${rosver} -eq 1 -o ${rosver} -eq 2 ]; then + exit_fail "Need a (valid) ROS version" + fi + + local res=0 + + # Create workspace + if [ ${dev} -gt 0 ]; then + notice "Creating debug ROS${rosver} workspace in ${abspath}" + else + notice "Creating release ROS${rosver} workspace in ${abspath}" + fi + mkdir -p ${abspath}/src + + # Path for symlink + local srcpath= + if [ -n "${relpath}" ]; then + srcpath=$(realpath -s --relative-to=${abspath}/src ${SCRIPTDIR}) + else + srcpath=${SCRIPTDIR} + fi + debug "srcpath=${srcpath}" + + # Symlink source packages + ln -s ${srcpath}/fixposition-sdk/fpsdk_common ${abspath}/src + ln -s ${srcpath}/fixposition-sdk/fpsdk_apps ${abspath}/src + ln -s ${srcpath}/fixposition_driver_lib ${abspath}/src + ln -s ${srcpath}/fixposition_driver_msgs ${abspath}/src + ln -s ${srcpath}/rtcm_msgs ${abspath}/src + if [ ${rosver} -eq 1 ]; then + ln -s ${srcpath}/fixposition-sdk/fpsdk_ros1 ${abspath}/src + ln -s ${srcpath}/fixposition_driver_ros1 ${abspath}/src + ln -s ${srcpath}/fixposition_odometry_converter_ros1 ${abspath}/src + else + ln -s ${srcpath}/fixposition-sdk/fpsdk_ros2 ${abspath}/src + ln -s ${srcpath}/fixposition_driver_ros2 ${abspath}/src + ln -s ${srcpath}/fixposition_odometry_converter_ros2 ${abspath}/src + fi + + # Initialise workspace + cd ${abspath} + if [ ${rosver} -eq 1 ]; then + catkin init + if [ ${dev} -gt 0 ]; then + catkin config --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Debug + else + catkin config --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Release + fi + else + if [ ${dev} -gt 0 ]; then + echo 'build:' > ${abspath}/colcon_defaults.yaml + echo ' event-handlers: [ "console_direct+" ]' >> ${abspath}/colcon_defaults.yaml + echo ' cmake-args: [ "-DCMAKE_BUILD_TYPE=Debug", "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON" ]' >> ${abspath}/colcon_defaults.yaml + else + echo 'build:' > ${abspath}/colcon_defaults.yaml + echo '# event-handlers: [ "console_direct+" ]' >> ${abspath}/colcon_defaults.yaml + echo ' cmake-args: [ "-DCMAKE_BUILD_TYPE=Release", "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON" ]' >> ${abspath}/colcon_defaults.yaml + fi + fi + + # Happy? + debug "res=${res}" + if [ ${res} -eq 0 ]; then + info "Splendid! You should now be able to:" + info "" + info " cd ${relpath}" + if [ ${rosver} -eq 1 ]; then + info " catkin build" + else + info " colcon build" + fi + info "" + exit 0 + else + error "Ouch" + exit 1 + fi + +} + +function exit_fail +{ + error "$@" + echo "Try '$0 -h' for help." 1>&2 + exit 1 +} + +function notice +{ + echo -e "\033[1;37m$@\033[m" 1>&2 +} + +function info +{ + echo -e "\033[0m$@\033[m" 1>&2 +} + +function warning +{ + echo -e "\033[1;33mWarning: $@\033[m" 1>&2 +} + +function error +{ + echo -e "\033[1;31mError: $@\033[m" 1>&2 +} + +function debug +{ + if [ ${DEBUG} -gt 0 ]; then + echo -e "\033[0;36mDebug: $@\033[m" 1>&2 + fi +} + +function panic +{ + local res=$? + echo -e "\033[1;35mPanic at ${BASH_SOURCE[1]}:${BASH_LINENO[0]}! ${BASH_COMMAND} (res=$res)\033[m" 1>&2 + exit $res +} + +main "$@" +exit 99 diff --git a/fixposition-sdk b/fixposition-sdk new file mode 160000 index 00000000..6d313dbf --- /dev/null +++ b/fixposition-sdk @@ -0,0 +1 @@ +Subproject commit 6d313dbfc343626a924811be944d81bcf3aea20b diff --git a/fixposition_driver.code-workspace b/fixposition_driver.code-workspace new file mode 100644 index 00000000..3d257dbb --- /dev/null +++ b/fixposition_driver.code-workspace @@ -0,0 +1,237 @@ +{ + "folders": [ + { "path": ".", "name": "fixposition_driver" } + ], + + "settings": { + "editor.detectIndentation": false, + "editor.tabSize": 4, // Note: only active if editor.- + "editor.insertSpaces": true, // detectIndentation is false! + //"editor.trimAutoWhitespace": true, + "files.trimTrailingWhitespace": true, + + // Leave big brother in the dark, mainly settings from @tag:usesOnlineServices + "telemetry.enableTelemetry": false, + "gitlens.telemetry.enabled": false, + "redhat.telemetry.enabled": false, + "telemetry.telemetrylevel": "off", + "workbench.enableExperiments": false, + "workbench.settings.enableNaturalLanguageSearch": false, + "npm.fetchOnlinePackageInfo": false, + + // Exclude files and folders from explorer (it automatically excludes .git) + "files.exclude": { + ".ackrc": true, + ".vscode-cache": true, + "**/*~": true, + ".vstags": true, + "core": true, + ".devcontainer/.vscode-server/**": true, + "**/.devcontainer/.vscode-server/**": true, + "**/.vscode-server/**": true + }, + // Exclude things from search (this automatically uses files.exclude + what you add here) + "search.exclude": { + "output": true, + "tmp": true, + "**/ros1_ws/**": true, + "**/ros2_ws/**": true + }, + // Exclude some things from the files watcher + "files.watcherExclude": { + "**/.git/objects/**": true, + "**/.git/refs/**": true, + "**/.git/logs/**": true, + "**/.git/subtree-cache/**": true, + "**/.git/worktrees/**": true, + "**/.vscode-*/**": true, + "**/ros1_ws/**": true, + "**/ros2_ws/**": true + }, + + // Microsoft C++ extension (ms-vscode.cpptools) + "C_Cpp.intelliSenseCachePath": "${workspaceFolder}/.vscode-cache", + // defaults for .vscode/c_cpp_properties.json (which makes that file optional) + // see .vscode/c_cpp_properties.json-example for details + // https://code.visualstudio.com/docs/cpp/customize-default-settings-cpp, + // https://code.visualstudio.com/docs/cpp/c-cpp-properties-schema-reference) + "C_Cpp.default.includePath": [ + "${workspaceFolder}/fixposition-sdk/fpsdk_common/**", + "${workspaceFolder}/fixposition-sdk/fpsdk_ros1/**", + "${workspaceFolder}/fixposition-sdk/fpsdk_ros2/**", + "${workspaceFolder}/fixposition-sdk/fpsdk_apps/**", + "${workspaceFolder}/fixposition_driver_lib/**", + "${workspaceFolder}/fixposition_driver_ros1/**", + "${workspaceFolder}/fixposition_driver_ros2/**", + "${workspaceFolder}/fixposition_odometry_converter_ros1/**", + "${workspaceFolder}/fixposition_odometry_converter_ros2/**", + "/opt/ros/noetic/include/**", "/opt/ros/humble/include/**", "/opt/ros/jazzy/include/**" ], + "C_Cpp.default.defines": [ "FP_USE_ROS1" ], + //"C_Cpp.default.compileCommands": "", + //"C_Cpp.default.forcedIncludes": [ ], + "C_Cpp.default.intelliSenseMode": "gcc-x64", + "C_Cpp.default.compilerPath": "/usr/bin/gcc", + "C_Cpp.default.cStandard": "gnu99", + "C_Cpp.default.cppStandard": "gnu++17", + "C_Cpp.default.browse.path": [ "${workspaceFolder}/**" ], + //"C_Cpp.default.configurationProvider": "b2.catkin_tools", + "C_Cpp.default.browse.databaseFilename": "${workspaceFolder}/.vscode-cache/browse.db", + //"C_Cpp.default.compileCommands": "${workspaceFolder}/build/Debug/compile_commands.json", + "C_Cpp.default.browse.limitSymbolsToIncludedHeaders": false, + //"C_Cpp.clang_format_style": "{ BasedOnStyle: Google, IndentWidth: 4, ColumnLimit: 120 }", + "C_Cpp.files.exclude": { + ".devcontainer/.vscode-server/**": true + }, + "editor.formatOnSave": false, + + "cmake.configureOnOpen": false, + "[shellscript]": { + "files.eol": "\n", + "files.trimTrailingWhitespace": false + }, + "[yaml]": { + "editor.indentSize": 4 + }, + "files.associations": { + "memory": "cpp", + "cctype": "cpp", + "clocale": "cpp", + "cmath": "cpp", + "csignal": "cpp", + "cstdarg": "cpp", + "cstddef": "cpp", + "cstdio": "cpp", + "cstdlib": "cpp", + "cstring": "cpp", + "ctime": "cpp", + "cwchar": "cpp", + "cwctype": "cpp", + "any": "cpp", + "array": "cpp", + "atomic": "cpp", + "strstream": "cpp", + "bit": "cpp", + "*.tcc": "cpp", + "bitset": "cpp", + "chrono": "cpp", + "cinttypes": "cpp", + "codecvt": "cpp", + "compare": "cpp", + "complex": "cpp", + "concepts": "cpp", + "condition_variable": "cpp", + "cstdint": "cpp", + "deque": "cpp", + "forward_list": "cpp", + "list": "cpp", + "map": "cpp", + "set": "cpp", + "string": "cpp", + "unordered_map": "cpp", + "unordered_set": "cpp", + "vector": "cpp", + "exception": "cpp", + "algorithm": "cpp", + "functional": "cpp", + "iterator": "cpp", + "memory_resource": "cpp", + "numeric": "cpp", + "optional": "cpp", + "random": "cpp", + "ratio": "cpp", + "regex": "cpp", + "string_view": "cpp", + "system_error": "cpp", + "tuple": "cpp", + "type_traits": "cpp", + "utility": "cpp", + "fstream": "cpp", + "future": "cpp", + "initializer_list": "cpp", + "iomanip": "cpp", + "iosfwd": "cpp", + "iostream": "cpp", + "istream": "cpp", + "limits": "cpp", + "mutex": "cpp", + "new": "cpp", + "numbers": "cpp", + "ostream": "cpp", + "semaphore": "cpp", + "sstream": "cpp", + "stdexcept": "cpp", + "stop_token": "cpp", + "streambuf": "cpp", + "thread": "cpp", + "cfenv": "cpp", + "typeindex": "cpp", + "typeinfo": "cpp", + "valarray": "cpp", + "variant": "cpp", + "*.ipp": "cpp", + "ranges": "cpp", + "shared_mutex": "cpp", + "core": "cpp", + "splines": "cpp" + }, + "workbench.remoteIndicator.showExtensionRecommendations": true, + "yaml.extension.recommendations": false, + "catkin_tools.cppStandard": "c++17", + "catkin_tools.defaultRosWorkspaces": [ + "/home/fpsdk/fixposition_driver/ros1_ws", + "/home/fpsdk/fixposition_driver/ros2_ws", + "ros1_ws", + "ros2_ws" + ] + }, + "extensions": { + "recommendations": [ + "ms-vscode.cpptools", + "twxs.cmake" + //,"betwo.b2-catkin-tools" + ], + "unwantedRecommendations": [ + ] + }, + + // Build and test tasks. Users can add more tasks in .vscode/tasks.json. + "tasks": { + // https://code.visualstudio.com/docs/editor/tasks + // https://code.visualstudio.com/docs/editor/tasks-appendix + "version": "2.0.0", + + // Defaults for all tasks + "options": { + "cwd": "${workspaceFolder}", + "shell": { "executable": "/bin/bash", "args": [ "-c" ] }, + "setupCommands": [ + { "text": "-enable-pretty-printing", "description": "enable pretty printing", "ignoreFailures": true }, + { "text": "handle SIGPIPE nostop noprint pass", "description": "ignore SIGPIPE", "ignoreFailures": true } + ] + }, + "problemMatcher": "$gcc", + "type": "shell", + + // Tasks definitions + "tasks": [ + // ----------------------------------------------------------------------------------------- + { + "label": "debug workspaceFolder path", + "group": "build", + "command": "echo ${workspaceFolder} && readlink -f ${workspaceFolder}" + } + ], + + // Input variables + "inputs": [ + // https://code.visualstudio.com/docs/editor/variables-reference#_input-variables + ] + }, + // Launch (debugging) + "launch": { + // https://code.visualstudio.com/docs/cpp/launch-json-reference + "configurations": [ + ], + "compounds": [] + } +} diff --git a/fixposition_driver_lib/CMakeLists.txt b/fixposition_driver_lib/CMakeLists.txt index 88fb4c6e..6fd0c39e 100644 --- a/fixposition_driver_lib/CMakeLists.txt +++ b/fixposition_driver_lib/CMakeLists.txt @@ -1,58 +1,49 @@ # GENERAL ============================================================================================================== -cmake_minimum_required(VERSION 3.5) -project(fixposition_driver_lib VERSION 5.0.0 LANGUAGES CXX) -set(CMAKE_CXX_STANDARD 14) -set(CMAKE_BUILD_TYPE "Release") -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic\ - -Wshadow -Wunused-parameter -Wformat -Wpointer-arith") + +cmake_minimum_required(VERSION 3.16) + +project(fixposition_driver_lib VERSION 8.0.0 LANGUAGES CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Werror\ + -Wshadow -Wunused-parameter -Wformat -Wpointer-arith -Woverloaded-virtual") set(CMAKE_CXX_FLAGS_RELEASE "-O3") set(CMAKE_EXPORT_COMPILE_COMMANDS ON) +if(NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE Release) +endif() +if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_definitions(NDEBUG) +endif() + # DEPENDENCIES ========================================================================================================= + find_package(Boost 1.65.0 REQUIRED) find_package(Eigen3 REQUIRED) +find_package(fpsdk_common REQUIRED) include_directories(include ${EIGEN3_INCLUDE_DIR} ${Boost_INCLUDE_DIR} + ${fpsdk_common_INCLUDE_DIR} ) + # BUILD EXECUTABLE ===================================================================================================== + add_library( ${PROJECT_NAME} SHARED - src/messages/fpa/corrimu.cpp - src/messages/fpa/eoe.cpp - src/messages/fpa/gnssant.cpp - src/messages/fpa/gnsscorr.cpp - src/messages/fpa/imubias.cpp - src/messages/fpa/llh.cpp - src/messages/fpa/odomenu.cpp - src/messages/fpa/odometry.cpp - src/messages/fpa/odomsh.cpp - src/messages/fpa/odomstatus.cpp - src/messages/fpa/rawimu.cpp - src/messages/fpa/text.cpp - src/messages/fpa/tf.cpp - src/messages/fpa/tp.cpp - src/messages/nmea/gpgga.cpp - src/messages/nmea/gpgll.cpp - src/messages/nmea/gngsa.cpp - src/messages/nmea/gpgst.cpp - src/messages/nmea/gxgsv.cpp - src/messages/nmea/gphdt.cpp - src/messages/nmea/gprmc.cpp - src/messages/nmea/gpvtg.cpp - src/messages/nmea/gpzda.cpp - src/messages/nmea/nmea.cpp src/fixposition_driver.cpp src/helper.cpp - src/parser.cpp - src/gnss_tf.cpp + src/params.cpp ) -target_link_libraries(${PROJECT_NAME} ${Boost_LIBRARIES} pthread) +target_link_libraries(${PROJECT_NAME} ${Boost_LIBRARIES} ${fpsdk_common_LIBRARIES} pthread) + # INSTALL ============================================================================================================== + list(APPEND PACKAGE_LIBRARIES ${PROJECT_NAME}) install( diff --git a/fixposition_driver_lib/Doxyfile b/fixposition_driver_lib/Doxyfile deleted file mode 100644 index 87bffb6e..00000000 --- a/fixposition_driver_lib/Doxyfile +++ /dev/null @@ -1,2427 +0,0 @@ -# Doxyfile 1.8.11 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "Fixposition Driver LIB" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = doc_gen - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL =YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = include src submodules README.md - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, -# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = README.md - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse-libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = YES - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /