summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java
blob: 5db768cb571a8696488e28e91b23d92beef57110 (plain)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
 * Copyright (c) 2017 - 2019, 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.
 */
package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.WarningLightStatus;

import java.util.Hashtable;

/**
 * <p>The status and pressure of the tires.</p>
 * <p><b> Parameter List:</b></p>
 *
 * <table border="1" rules="all">
 * 		<tr>
 * 			<th>Param Name</th>
 * 			<th>Type</th>
 * 			<th>Description</th>
 *          <th>Version</th>
 * 		</tr>
 * 		<tr>
 * 			<td>PressureTellTale</td>
 * 			<td>WarningLightStatus</td>
 * 			<td>Status of the Tire Pressure TellTale</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * <tr>
 * 			<td>LeftFront</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the left front tire.</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * <tr>
 * 			<td>RightFront</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the right front tire.</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * <tr>
 * 			<td>LeftRear</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the left rear tire.</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>RightRear</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the right rear tire</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>InnerLeftRear</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the inner left rear tire.</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>InnerRightRear</td>
 * 			<td>SingleTireStatus</td>
 * 			<td>The status of the inner right rear tire.</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 *  </table>
 * <p>
 *  @since SmartDeviceLink 2.0
 *
 * @see WarningLightStatus
 * @see SingleTireStatus
 * @see GetVehicleData
 * @see OnVehicleData
 */

public class TireStatus extends RPCStruct {
    public static final String KEY_PRESSURE_TELL_TALE = "pressureTelltale";
    public static final String KEY_LEFT_FRONT = "leftFront";
    public static final String KEY_RIGHT_FRONT = "rightFront";
    public static final String KEY_LEFT_REAR = "leftRear";
    public static final String KEY_INNER_LEFT_REAR = "innerLeftRear";
    public static final String KEY_INNER_RIGHT_REAR = "innerRightRear";
    public static final String KEY_RIGHT_REAR = "rightRear";

    public TireStatus() {
    }

    /**
     * <p>Constructs a new TireStatus object indicated by the Hashtable parameter</p>
     *
     * @param hash The Hashtable to use
     */
    public TireStatus(Hashtable<String, Object> hash) {
        super(hash);
    }

    /**
     * Constructs a new TireStatus object
     *
     * @param pressureTellTale Status of the Tire Pressure TellTale
     * @param leftFront        The status of the left front tire.
     * @param rightFront       The status of the right front tire.
     * @param leftRear         The status of the left rear tire.
     * @param rightRear        The status of the right rear tire
     * @param innerLeftRear    The status of the inner left rear tire.
     * @param innerRightRear   The status of the inner right rear tire.
     */
    public TireStatus(@NonNull WarningLightStatus pressureTellTale, @NonNull SingleTireStatus leftFront, @NonNull SingleTireStatus rightFront, @NonNull SingleTireStatus leftRear, @NonNull SingleTireStatus rightRear, @NonNull SingleTireStatus innerLeftRear, @NonNull SingleTireStatus innerRightRear) {
        this();
        setPressureTelltale(pressureTellTale);
        setLeftFront(leftFront);
        setRightFront(rightFront);
        setLeftRear(leftRear);
        setRightRear(rightRear);
        setInnerLeftRear(innerLeftRear);
        setInnerRightRear(innerRightRear);
    }

    /**
     * @deprecated use {@link #setPressureTelltale(WarningLightStatus pressureTellTale)} instead.
     */
    @Deprecated
    public TireStatus setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {
        return setPressureTelltale(pressureTellTale);
    }

    /**
     * @deprecated use {@link #getPressureTelltale()} instead.
     */
    @Deprecated
    public WarningLightStatus getPressureTellTale() {
        return getPressureTelltale();
    }

    /**
     * Sets the status of the tire pressure Telltale.
     *
     * @param pressureTellTale the status of the tire pressure Telltale.
     */
    public TireStatus setPressureTelltale(@NonNull WarningLightStatus pressureTellTale) {
        setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
        return this;
    }

    /**
     * Gets the status of the tire pressure Telltale.
     *
     * @return the status of the tire pressure Telltale.
     */
    public WarningLightStatus getPressureTelltale() {
        return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);
    }

    public TireStatus setLeftFront(@NonNull SingleTireStatus leftFront) {
        setValue(KEY_LEFT_FRONT, leftFront);
        return this;
    }

    public SingleTireStatus getLeftFront() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_FRONT);
    }

    public TireStatus setRightFront(@NonNull SingleTireStatus rightFront) {
        setValue(KEY_RIGHT_FRONT, rightFront);
        return this;
    }

    public SingleTireStatus getRightFront() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_FRONT);
    }

    public TireStatus setLeftRear(@NonNull SingleTireStatus leftRear) {
        setValue(KEY_LEFT_REAR, leftRear);
        return this;
    }

    public SingleTireStatus getLeftRear() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_REAR);
    }

    public TireStatus setRightRear(@NonNull SingleTireStatus rightRear) {
        setValue(KEY_RIGHT_REAR, rightRear);
        return this;
    }

    public SingleTireStatus getRightRear() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_REAR);
    }

    public TireStatus setInnerLeftRear(@NonNull SingleTireStatus innerLeftRear) {
        setValue(KEY_INNER_LEFT_REAR, innerLeftRear);
        return this;
    }

    public SingleTireStatus getInnerLeftRear() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_INNER_LEFT_REAR);
    }

    public TireStatus setInnerRightRear(@NonNull SingleTireStatus innerRightRear) {
        setValue(KEY_INNER_RIGHT_REAR, innerRightRear);
        return this;
    }

    public SingleTireStatus getInnerRightRear() {
        return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_INNER_RIGHT_REAR);
    }
}