File : data/NoteAndRoute.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
/* ------------------------------------------------------------------------------------------------------------------------- */
26
/**
27
A container with a note and the route to witch the note is linked
28
*/
29
/* ------------------------------------------------------------------------------------------------------------------------- */
30
31
class NoteAndRoute {
32
33
    /**
34
    The Note
35
    @type {?Note}
36
    */
37
38
    #note;
39
40
    /**
41
    The route
42
    @type {?Route}
43
    */
44
45
    #route;
46
47
    /**
48
    The constructor
49
    @param {Note} note The note to store
50
    @param {Route} route The route to store
51
    */
52
53
    constructor ( note, route ) {
54
        Object.freeze ( this );
55
        this.#note = note;
56
        this.#route = route;
57
    }
58
59
    /**
60
    The Note
61
    @type {?Note}
62
    */
63
64
    get note ( ) { return this.#note; }
65
66
    /**
67
    The route
68
    @type {?Route}
69
    */
70
71
    get route ( ) { return this.#route; }
72
}
73
74
export default NoteAndRoute;
75
76
/* --- End of file --------------------------------------------------------------------------------------------------------- */
77