PathPlanningProject

Исходный код проекта по планированию траекторий.

Описание программы

Программа решает задачу планирования траектории движения некоторого объекта (например, робота) на плоскости, подчиняющейся следующим условиям:

во-первых, плоскость должна представлять из себя прямоугольник со сторонами, параллельными осям координат
во-вторых, она должна быть разлинована в виде сетки из маленьких прямоугольников
в-третьих, каждый маленький прямоугольник (клетка) должен быть отнесён ровно к одному из двух типов: свободная клетка или занятая

Задача: построить оптимальный путь из одной свободной клетки в другую через свободные клетки или выдать результат, что такого пути не существует. Конкретные опции пути можно задать в файле, который подаётся на вход программе.

На данный момент поддерживаются алгоритм Дейкстры и алгоритм A*.

Входные данные

На вход в качестве аргумента командной строки подаётся XML-файл, имеющий следующую структуру:

<root>
     <map> — параметры карты
         <width> — ширина карты (количество клеток по оси X)
         <height> — высота карты (количество клеток по оси Y)
         <cellsize> — размер клеток карты
         <startx> — координата начальной точки по X
         <starty> — координата начальной точки по Y
         <finishx> — координата конечной точки по X
         <finishy> — координата конечной точки по Y
         <grid> — сама карта
             <row> — строка карты
     <algorithm> — параметры алгоритма
         <metrictype> — метрика, используемая в эвристической функции (euclidean, manhattan, chebyshev, diagonal)
         <searchtype> — алгоритм поиска (dijkstra или astar)
         <hweight> — вес эвристики
         <allowdiagonal> — можно ли делать диагональные ходы
         <cutcorners> — можно ли делать диагональные ходы, когда одна соседняя клетка занята
         <allowsqueeze> — можно ли делать ходы через "бутылочное горлышко"
     <options> — параметры отображения результата

Выходные данные

Результат работы представляется в виде XML-файла, в котором, помимо входных данных, есть следующая информация:

     <log>
         <mapfilename> — путь к файлу со входными данными
         <summary> — количество шагов, количество сгенерированных узлов, длина пути, время поиска ответа
         <path> — исходная карта и обозначенный на ней путь
             <row> — строка карты
         <lplevel> — путь в виде последовательности узлов
             <node> — координаты узла и его номер
         <hplevel> — путь в виде последовательности секций
             <section> — координаты начала и конца секции и её длина

Сборка и запуск

Сборку проекта возможно осуществить двумя способами:

Используя QtCreator и qmake;
Используя CMake.

При использовании QtCreator требуется открыть файл ASearch.pro который находится в директории .../PathPlanningProject/Src/ и настроить проект с нужным комплектом сборки.

После выбора проекта требуется установить имя входного файла как аргумент командной строки. В качестве первого примера используйте файл .../PathPlanningProject/Examples/example.xml. Для установки аргументов командной строки перейдите в настройки запуска проекта и введите нужный путь к файлу в поле "Параметры командной строки".

После установки аргумента командной строки можно проверить работу программы. Следующий результат должен отобразиться в результате запуска:

Parsing the map from XML:
Map OK!
Parsing configurations (algorithm, log) from XML:
short
Warning! Value of 'logpath' tag is missing!
Value of 'logpath' tag was defined to 'current directory'.
Warning! Value of 'logfilename' tag is missing.
Value of 'logfilename' tag was defined to default (original filename +'_log' + original file extension.
Configurations OK!
Creating log channel:
Log OK!
Start searching the path:
Search is finished!
Path NOT found!
numberofsteps=0
nodescreated=0
time=0
Results are saved (if chosen) via created log channel.

При использовании CMake сборка и запуск может производиться как из командной строки, так и при помощи различных IDE (например JetBrains CLion). Ниже приведены скрипты сборки и запуска с использованием командной строки.

Linux и Mac

Release сборка:

cd PathPlanningProject
cd Build
cd Release
cmake ../../ -DCMAKE_BUILD_TYPE="Release"
make
make install

Debug сборка:

cd PathPlanningProject
cd Build
cd Debug
cmake ../../ -DCMAKE_BUILD_TYPE="Debug"
make
make install

Запуск:

cd ../../Bin/{Debug|Release}/
./PathPlanning ../../Examples/example.xml

Результат запуска:

Windows

Release сборка:

cd PathPlanningProject
cd Build
cd Release
set PATH
cmake ../../ -DCMAKE_BUILD_TYPE="Release" -G "MinGW Makefiles"
mingw32-make
mingw32-make install

Debug сборка:

cd PathPlanningProject
cd Build
cd Debug
set PATH
cmake ../../ -DCMAKE_BUILD_TYPE="Debug" -G "MinGW Makefiles"
mingw32-make
mingw32-make install

Запуск:

cd ../../Bin/{Debug|Release}/
PathPlanning.exe ../../Examples/example.xml

Результат запуска:

Тестирование

Linux test result:

Windows test result:

При использовании сборки CMake возможен запуск тестов, как локально, так и с использованием Travis CI и AppVeyor. Локальный запуск тестов производится из директории .../PathPlanningProject/Build/{Debug|Release}/ с помощью команды:

 ctest

либо (для более подробного вывода):

 ctest --output-on-failure

При попытке запуска тестов c использованием пустого шаблона должен получиться следующий результат:

      Start  1: Test1
 1/12 Test  #1: Test1 ............................***Failed    0.07 sec
      Start  2: Test2
 2/12 Test  #2: Test2 ............................***Failed    0.07 sec
      Start  3: Test3
 3/12 Test  #3: Test3 ............................***Failed    0.06 sec
      Start  4: Test4
 4/12 Test  #4: Test4 ............................***Failed    0.07 sec
      Start  5: Test5
 5/12 Test  #5: Test5 ............................***Failed    0.07 sec
      Start  6: Test6
 6/12 Test  #6: Test6 ............................***Failed    0.06 sec
      Start  7: Test7
 7/12 Test  #7: Test7 ............................***Failed    0.06 sec
      Start  8: Test8
 8/12 Test  #8: Test8 ............................***Failed    0.06 sec
      Start  9: Test9
 9/12 Test  #9: Test9 ............................***Failed    0.06 sec
      Start 10: Test10
10/12 Test #10: Test10 ...........................***Failed    0.07 sec
      Start 11: Test11
11/12 Test #11: Test11 ...........................***Failed    0.06 sec
      Start 12: Test12
12/12 Test #12: Test12 ...........................***Failed    0.06 sec

0% tests passed, 12 tests failed out of 12

Total Test time (real) =   0.80 sec

The following tests FAILED:
	  1 - Test1 (Failed)
	  2 - Test2 (Failed)
	  3 - Test3 (Failed)
	  4 - Test4 (Failed)
	  5 - Test5 (Failed)
	  6 - Test6 (Failed)
	  7 - Test7 (Failed)
	  8 - Test8 (Failed)
	  9 - Test9 (Failed)
	 10 - Test10 (Failed)
	 11 - Test11 (Failed)
	 12 - Test12 (Failed)
Errors while running CTest

Контакты

Яковлев Константин Сергеевич

kyakovlev@hse.ru
Сайт НИУ ВШЭ
Telegram: @KonstantinYakovlev

Дергачев Степан

sadergachev@edu.hse.ru
Telegram: @haiot4105

AnthonyUdovichenko / PathPlanningProject