-
Notifications
You must be signed in to change notification settings - Fork 13
/
RoofStatus.js
115 lines (105 loc) · 3.87 KB
/
RoofStatus.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/* eslint-disable camelcase */
/*
* Copyright (c) 2022, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium Inc. nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import { DoorStatusType } from '../enums/DoorStatusType.js';
import { Grid } from './Grid.js';
import { RpcStruct } from '../RpcStruct.js';
import { WindowState } from './WindowState.js';
/**
* Describes the status of a parameter of roof/convertible roof/sunroof/moonroof etc. If roof is open (AJAR), state will determine percentage of roof open.
*/
class RoofStatus extends RpcStruct {
/**
* Initializes an instance of RoofStatus.
* @class
* @param {object} parameters - An object map of parameters.
* @since SmartDeviceLink 7.1.0
*/
constructor (parameters) {
super(parameters);
}
/**
* Set the Location
* @param {Grid} location - Describes a location (origin coordinates and span) of a vehicle component. - The desired Location.
* @returns {RoofStatus} - The class instance for method chaining.
*/
setLocation (location) {
this._validateType(Grid, location);
this.setParameter(RoofStatus.KEY_LOCATION, location);
return this;
}
/**
* Get the Location
* @returns {Grid} - the KEY_LOCATION value
*/
getLocation () {
return this.getObject(Grid, RoofStatus.KEY_LOCATION);
}
/**
* Set the Status
* @param {DoorStatusType} status - The desired Status.
* @returns {RoofStatus} - The class instance for method chaining.
*/
setStatus (status) {
this._validateType(DoorStatusType, status);
this.setParameter(RoofStatus.KEY_STATUS, status);
return this;
}
/**
* Get the Status
* @returns {DoorStatusType} - the KEY_STATUS value
*/
getStatus () {
return this.getObject(DoorStatusType, RoofStatus.KEY_STATUS);
}
/**
* Set the State
* @param {WindowState} state - The desired State.
* @returns {RoofStatus} - The class instance for method chaining.
*/
setState (state) {
this._validateType(WindowState, state);
this.setParameter(RoofStatus.KEY_STATE, state);
return this;
}
/**
* Get the State
* @returns {WindowState} - the KEY_STATE value
*/
getState () {
return this.getObject(WindowState, RoofStatus.KEY_STATE);
}
}
RoofStatus.KEY_LOCATION = 'location';
RoofStatus.KEY_STATUS = 'status';
RoofStatus.KEY_STATE = 'state';
export { RoofStatus };