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
|
/*
* 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 com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import java.util.Hashtable;
import java.util.List;
/**
* Updates the list of next maneuvers, which can be requested by the user pressing the softbutton "Turns" on the
* Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close
*
* <p>Function Group: Navigation</p>
*
* <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
*
*
* @since SmartDeviceLink 2.0
* @see ShowConstantTbt
*/
public class UpdateTurnList extends RPCRequest{
public static final String KEY_TURN_LIST = "turnList";
public static final String KEY_SOFT_BUTTONS = "softButtons";
/**
* Constructs a new UpdateTurnList object
*/
public UpdateTurnList() {
super(FunctionID.UPDATE_TURN_LIST.toString());
}
/**
* <p>
* Constructs a new UpdateTurnList object indicated by the Hashtable
* parameter
* </p>
*
* @param hash
* The Hashtable to use
*/
public UpdateTurnList(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Sets a list of turns to be shown to the user
*
* @param turnList
* a List<Turn> value representing a list of turns to be shown to the user
* <p>
* <b>Notes: </b>Minsize=1; Maxsize=100</p>
*/
public void setTurnList(List<Turn> turnList){
setParameters(KEY_TURN_LIST, turnList);
}
/**
* Gets a list of turns to be shown to the user
*
* @return List<Turn> -a List value representing a list of turns
*/
@SuppressWarnings("unchecked")
public List<Turn> getTurnList(){
return (List<Turn>) getObject(Turn.class, KEY_TURN_LIST);
}
/**
* Gets the SoftButton List object
*
* @return List<SoftButton> -a List<SoftButton> representing the List object
* @since SmartDeviceLink 2.0
*/
@SuppressWarnings("unchecked")
public List<SoftButton> getSoftButtons(){
return (List<SoftButton>) getObject(SoftButton.class, KEY_SOFT_BUTTONS);
}
/**
* Sets the SoftButtons
*
* @param softButtons
* a List<SoftButton> value
* <p>
* <b>Notes: </b></p>
* <ul>
* <li>If omitted on supported displays, the alert will not have any SoftButton</li>
* <li>ArrayMin: 0</li>
* <li>ArrayMax: 1</li>
* </ul>
* @since SmartDeviceLink 2.0
*/
public void setSoftButtons(List<SoftButton> softButtons){
setParameters(KEY_SOFT_BUTTONS, softButtons);
}
}
|
