File : containers/LatLngElevOnRoute.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
Changes:
20
    - v4.0.0:
21
        - created from v3.6.0
22
Doc reviewed 202208
23
*/
24
25
import LatLngDistance from './LatLngDistance.js';
26
27
/* ------------------------------------------------------------------------------------------------------------------------- */
28
/**
29
A simple container to store the latitude, longitude, elevation, ascent and distance
30
*/
31
/* ------------------------------------------------------------------------------------------------------------------------- */
32
33
class LatLngElevOnRoute extends LatLngDistance {
34
35
    /**
36
    The elevation
37
    @type {Number}
38
    */
39
40
    #elev;
41
42
    /**
43
    The ascent
44
    @type {Number}
45
    */
46
47
    #ascent;
48
49
    /**
50
    The constructor
51
    @param {Number} lat The lat
52
    @param {Number} lng The lng
53
    @param {Number} distance The distance
54
    @param {Number} elev The elevation
55
    @param {Number} ascent The ascent
56
    */
57
58
    // eslint-disable-next-line max-params
59
    constructor ( lat, lng, distance, elev, ascent ) {
60
        super ( lat, lng, distance );
61
        this.#elev = elev;
62
        this.#ascent = ascent;
63
    }
64
65
    /**
66
    The elevation
67
    @type {Number}
68
    */
69
70
    get elev ( ) { return this.#elev; }
71
72
    /**
73
    The ascent
74
    @type {Number}
75
    */
76
77
    get ascent ( ) { return this.#ascent; }
78
}
79
80
export default LatLngElevOnRoute;
81
82
/* --- End of file --------------------------------------------------------------------------------------------------------- */
83