| 1 | /* |
| 2 | Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/ |
| 3 | |
| 4 | This program is free software; |
| 5 | you can redistribute it and/or modify it under the terms of the |
| 6 | GNU General Public License as published by the Free Software Foundation; |
| 7 | either version 3 of the License, or any later version. |
| 8 | |
| 9 | This program is distributed in the hope that it will be useful, |
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | GNU General Public License for more details. |
| 13 | |
| 14 | You should have received a copy of the GNU General Public License |
| 15 | along with this program; if not, write to the Free Software |
| 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 17 | */ |
| 18 | /* |
| 19 | Changes: |
| 20 | - v4.0.0: |
| 21 | - created from v3.6.0 |
| 22 | Doc reviewed 202208 |
| 23 | */ |
| 24 | |
| 25 | import { ZERO, LAT_LNG } from '../main/Constants.js'; |
| 26 | |
| 27 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 28 | /** |
| 29 | A container with data found when searching the nearest route from a point |
| 30 | */ |
| 31 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 32 | |
| 33 | class DataSearchEngineNearestRouteData { |
| 34 | |
| 35 | /** |
| 36 | The constructor |
| 37 | */ |
| 38 | |
| 39 | constructor ( ) { |
| 40 | Object.seal ( this ); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | The distance between the given point and the nearest point on the route |
| 45 | @type {Number} |
| 46 | */ |
| 47 | |
| 48 | distance = Number.MAX_VALUE; |
| 49 | |
| 50 | /** |
| 51 | The route on witch the point was found |
| 52 | @type {Route} |
| 53 | */ |
| 54 | |
| 55 | route = null; |
| 56 | |
| 57 | /** |
| 58 | The distance between the beginning of the route and the nearest point |
| 59 | @type {Number} |
| 60 | */ |
| 61 | |
| 62 | distanceOnRoute = ZERO; |
| 63 | |
| 64 | /** |
| 65 | The lat and lng of the nearest point on the route |
| 66 | @type {Array.<Number>} |
| 67 | */ |
| 68 | |
| 69 | latLngOnRoute = [ LAT_LNG.defaultValue, LAT_LNG.defaultValue ]; |
| 70 | } |
| 71 | |
| 72 | export default DataSearchEngineNearestRouteData; |
| 73 | |
| 74 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
| 75 |