File : containers/PoiData.js

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
/*
20
Changes:
21
    - v4.0.0:
22
        - created from v3.6.0
23
Doc reviewed 202208
24
*/
25
26
/* ------------------------------------------------------------------------------------------------------------------------- */
27
/**
28
A simple container with the lat, lng and geometry of a point of interest
29
*/
30
/* ------------------------------------------------------------------------------------------------------------------------- */
31
32
class PoiData {
33
34
    /**
35
    The lat and lng of the POI
36
    @type {Array.<Number>}
37
    */
38
39
    #latLng;
40
41
    /**
42
    The geometry of the POI  The lat and lng of the objects representing the POI on OSM ( POI can be a point ,
43
    a polyline or a relation ).
44
    @type {Array.<Array.<Array.<Number>>>}
45
    */
46
47
    #geometry;
48
49
    /**
50
    The constructor
51
    @param {Array.<Number>} latLng The lat and lng of the POI
52
    @param {Array.<Array.<Array.<Number>>>} geometry
53
    */
54
55
    constructor ( latLng, geometry ) {
56
        this.#latLng = latLng;
57
        this.#geometry = geometry;
58
    }
59
60
    /**
61
    The lat and lng of the POI
62
    @type {Array.<Number>} The geometry of the POI
63
    */
64
65
    get latLng ( ) { return this.#latLng; }
66
67
    /**
68
    The geometry of the POI  The lat and lng of the objects representing the POI on OSM ( POI can be a point ,
69
    a polyline or a relation ).
70
    @type {Array.<Array.<Array.<Number>>>}
71
    */
72
73
    get geometry ( ) { return this.#geometry; }
74
75
}
76
77
export default PoiData;
78
79
/* --- End of file --------------------------------------------------------------------------------------------------------- */
80