diff options
| author | kboskin <kboskin> | 2020-12-12 12:58:19 +0200 |
|---|---|---|
| committer | kboskin <kboskin> | 2020-12-12 12:58:19 +0200 |
| commit | b1581cab64c3c997b02802c34740674fede87fdf (patch) | |
| tree | 20bd1b24e79433ace72ef99839696ae2c60bc526 | |
| parent | 773ab7f12e78079075fb23a0604e0de678a35bf3 (diff) | |
| download | sdl_android-b1581cab64c3c997b02802c34740674fede87fdf.tar.gz | |
[0262]
- Rollback of CRLF formatting
3 files changed, 1931 insertions, 1931 deletions
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index 6ef981a58..876cf99a0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -1,1053 +1,1053 @@ -/* - * 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; - -/** - * This function is used to unsubscribe the notifications from the - * subscribeVehicleData function - * <p>Function Group: Location, VehicleInfo and DrivingChara</p> - * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p> - * - * <p><b>Parameter List</b></p> - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>Reg.</th> - * <th>Notes</th> - * <th>Version</th> - * </tr> - * <tr> - * <td>gps</td> - * <td>Boolean</td> - * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>speed</td> - * <td>Boolean</td> - * <td>The vehicle speed in kilometers per hour</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>rpm</td> - * <td>Boolean</td> - * <td>The number of revolutions per minute of the engine</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>fuelLevel</td> - * <td>Boolean</td> - * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>fuelLevel_State</td> - * <td>Boolean</td> - * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>fuelRange</td> - * <td>Boolean</td> - * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 5.0.0</td> - * </tr> - * <tr> - * <td>instantFuelConsumption</td> - * <td>Boolean</td> - * <td>The instantaneous fuel consumption in micro litres</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>externalTemperature</td> - * <td>Boolean</td> - * <td>The external temperature in degrees celsius</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>gearStatus</td> - * <td>Boolean</td> - * <td>See GearStatus</td> - * <td>N</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>prndl</td> - * <td>Boolean</td> - * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td> - * <td>N</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>tirePressure</td> - * <td>Boolean</td> - * <td>Tire pressure status</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>odometer</td> - * <td>Boolean</td> - * <td>Odometer in km</td> - * <td>N</td> - * <td>Max Length: 500</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>beltStatus</td> - * <td>Boolean</td> - * <td>The status of the seat belts</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>bodyInformation</td> - * <td>Boolean</td> - * <td>The body information including ignition status and internal temp</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>deviceStatus</td> - * <td>Boolean</td> - * <td>The device status including signal and battery strength</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>driverBraking</td> - * <td>Boolean</td> - * <td>The status of the brake pedal</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>wiperStatus</td> - * <td>Boolean</td> - * <td>The status of the wipers</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>headLampStatus</td> - * <td>Boolean</td> - * <td>Status of the head lamps</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>engineTorque</td> - * <td>Boolean</td> - * <td>Torque value for engine (in Nm) on non-diesel variants</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>engineOilLife</td> - * <td>Boolean</td> - * <td>The estimated percentage of remaining oil life of the engine</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 5.0 </td> - * </tr> - * <tr> - * <td>accPedalPosition</td> - * <td>Boolean</td> - * <td>Accelerator pedal position (percentage depressed)</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>steeringWheelAngle</td> - * <td>Boolean</td> - * <td>Current angle of the steering wheel (in deg)</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>eCallInfo</td> - * <td>Boolean</td> - * <td>Emergency Call notification and confirmation data.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>airbagStatus</td> - * <td>Boolean</td> - * <td>The status of the air bags.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>emergencyEvent</td> - * <td>Boolean</td> - * <td>Information related to an emergency event (and if it occurred).</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>clusterModeStatus</td> - * <td>Boolean</td> - * <td>The status modes of the instrument panel cluster.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>myKey</td> - * <td>Boolean</td> - * <td>Information related to the MyKey feature.</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 2.0 </td> - * </tr> - * <tr> - * <td>turnSignal</td> - * <td>Boolean</td> - * <td>@see TurnSignal</td> - * <td>N</td> - * <td>Subscribable</td> - * <td>SmartDeviceLink 5.0 </td> - * </tr> - * <tr> - * <td>handsOffSteering</td> - * <td>Boolean</td> - * <td>To indicate whether driver hands are off the steering wheel</td> - * <td>N</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>windowStatus</td> - * <td>Boolean</td> - * <td>See WindowStatus</td> - * <td>N</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>stabilityControlsStatus</td> - * <td>Boolean</td> - * <td>See StabilityControlsStatus</td> - * <td>N</td> - * <td>SmartDeviceLink 7.0.0</td> - * </tr> - * <tr> - * <td>seatOccupancy</td> - * <td>Boolean</td> - * <td>See SeatOccupancy</td> - * <td>N</td> - * <td></td> - * <td> - * @since SmartDeviceLink 7.1.0 - * </td> - * </tr> - * - * - * </table> - * <p><b> Response</b></p> - * <p><b>Non-default Result Codes:</b></p> - * <p>SUCCESS</p> - * <p>WARNINGS</p> - * <p>INVALID_DATA</p> - * <p>OUT_OF_MEMORY</p> - * <p>TOO_MANY_PENDING_REQUESTS</p> - * <p>APPLICATION_NOT_REGISTERED</p> - * <p>GENERIC_ERROR</p> - * <p>IGNORED</p> - * <p>DISALLOWED</p> - * - * @see SubscribeVehicleData - * @see GetVehicleData - * @since SmartDeviceLink 2.0 - */ -public class UnsubscribeVehicleData extends RPCRequest { - public static final String KEY_SPEED = "speed"; - public static final String KEY_RPM = "rpm"; - public static final String KEY_EXTERNAL_TEMPERATURE = "externalTemperature"; - public static final String KEY_PRNDL = "prndl"; - public static final String KEY_TIRE_PRESSURE = "tirePressure"; - public static final String KEY_ENGINE_TORQUE = "engineTorque"; - public static final String KEY_ENGINE_OIL_LIFE = "engineOilLife"; - public static final String KEY_ODOMETER = "odometer"; - public static final String KEY_GPS = "gps"; - public static final String KEY_INSTANT_FUEL_CONSUMPTION = "instantFuelConsumption"; - public static final String KEY_BELT_STATUS = "beltStatus"; - public static final String KEY_BODY_INFORMATION = "bodyInformation"; - public static final String KEY_DEVICE_STATUS = "deviceStatus"; - public static final String KEY_DRIVER_BRAKING = "driverBraking"; - public static final String KEY_WIPER_STATUS = "wiperStatus"; - public static final String KEY_HEAD_LAMP_STATUS = "headLampStatus"; - public static final String KEY_ACC_PEDAL_POSITION = "accPedalPosition"; - public static final String KEY_STEERING_WHEEL_ANGLE = "steeringWheelAngle"; - public static final String KEY_E_CALL_INFO = "eCallInfo"; - public static final String KEY_AIRBAG_STATUS = "airbagStatus"; - public static final String KEY_EMERGENCY_EVENT = "emergencyEvent"; - public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus"; - public static final String KEY_MY_KEY = "myKey"; - public static final String KEY_FUEL_RANGE = "fuelRange"; - public static final String KEY_TURN_SIGNAL = "turnSignal"; - public static final String KEY_ELECTRONIC_PARK_BRAKE_STATUS = "electronicParkBrakeStatus"; - public static final String KEY_CLOUD_APP_VEHICLE_ID = "cloudAppVehicleID"; - public static final String KEY_HANDS_OFF_STEERING = "handsOffSteering"; - public static final String KEY_GEAR_STATUS = "gearStatus"; - public static final String KEY_WINDOW_STATUS = "windowStatus"; - /** - * @deprecated - */ - @Deprecated - public static final String KEY_FUEL_LEVEL = "fuelLevel"; - /** - * @deprecated - */ - @Deprecated - public static final String KEY_FUEL_LEVEL_STATE = "fuelLevel_State"; - public static final String KEY_STABILITY_CONTROLS_STATUS = "stabilityControlsStatus"; - /** - * @since SmartDeviceLink 7.1.0 - */ - public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy"; - - /** - * Constructs a new UnsubscribeVehicleData object - */ - public UnsubscribeVehicleData() { - super(FunctionID.UNSUBSCRIBE_VEHICLE_DATA.toString()); - } - - /** - * Constructs a new UnsubscribeVehicleData object indicated by the Hashtable - * parameter - * <p></p> - * - * @param hash The Hashtable to use - */ - public UnsubscribeVehicleData(Hashtable<String, Object> hash) { - super(hash); - } - - /** - * Sets a boolean value. If true, unsubscribes from Gps data - * - * @param gps a boolean value - */ - public UnsubscribeVehicleData setGps(Boolean gps) { - setParameters(KEY_GPS, gps); - return this; - } - - /** - * Gets a boolean value. If true, means the Gps data has been unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the Gps data has been - * unsubscribed. - */ - public Boolean getGps() { - return getBoolean(KEY_GPS); - } - - /** - * Sets a boolean value. If true, unsubscribes from speed data - * - * @param speed a boolean value - */ - public UnsubscribeVehicleData setSpeed(Boolean speed) { - setParameters(KEY_SPEED, speed); - return this; - } - - /** - * Gets a boolean value. If true, means the Speed data has been unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the Speed data has been - * unsubscribed. - */ - public Boolean getSpeed() { - return getBoolean(KEY_SPEED); - } - - /** - * Sets a boolean value. If true, unsubscribe data - * - * @param rpm a boolean value - */ - public UnsubscribeVehicleData setRpm(Boolean rpm) { - setParameters(KEY_RPM, rpm); - return this; - } - - /** - * Gets a boolean value. If true, means the rpm data has been unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the rpm data has been - * unsubscribed. - */ - public Boolean getRpm() { - return getBoolean(KEY_RPM); - } - - /** - * Sets the fuelLevel. - * - * @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec - * 7.0, please see fuelRange. - */ - @Deprecated - public UnsubscribeVehicleData setFuelLevel(Boolean fuelLevel) { - setParameters(KEY_FUEL_LEVEL, fuelLevel); - return this; - } - - /** - * Gets the fuelLevel. - * - * @return Boolean The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec - * 7.0, please see fuelRange. - */ - @Deprecated - public Boolean getFuelLevel() { - return getBoolean(KEY_FUEL_LEVEL); - } - - /** - * Sets the fuelRange. - * - * @param fuelLevelState The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the - * vehicle. See struct FuelRange for details. - * @since SmartDeviceLink 5.0.0 - */ - @Deprecated - public UnsubscribeVehicleData setFuelLevelState(Boolean fuelLevelState) { - setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState); - return this; - } - - /** - * Gets the fuelRange. - * - * @return Boolean The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the - * vehicle. See struct FuelRange for details. - * @since SmartDeviceLink 5.0.0 - */ - @Deprecated - public Boolean getFuelLevelState() { - return getBoolean(KEY_FUEL_LEVEL_STATE); - } - - /** - * Sets a boolean value. If true, unsubscribes from instantFuelConsumption data - * - * @param instantFuelConsumption a boolean value - */ - public UnsubscribeVehicleData setInstantFuelConsumption(Boolean instantFuelConsumption) { - setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption); - return this; - } - - /** - * Gets a boolean value. If true, means the getInstantFuelConsumption data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the getInstantFuelConsumption data - * has been unsubscribed. - */ - public Boolean getInstantFuelConsumption() { - return getBoolean(KEY_INSTANT_FUEL_CONSUMPTION); - } - - /** - * Sets a boolean value. If true, unsubscribes from externalTemperature data - * - * @param externalTemperature a boolean value - */ - public UnsubscribeVehicleData setExternalTemperature(Boolean externalTemperature) { - setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature); - return this; - } - - /** - * Gets a boolean value. If true, means the externalTemperature data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the externalTemperature data - * has been unsubscribed. - */ - public Boolean getExternalTemperature() { - return getBoolean(KEY_EXTERNAL_TEMPERATURE); - } - - /** - * Sets the prndl. - * - * @param prndl See PRNDL. This parameter since SmartDeviceLink 7.0.0 is deprecated and it is now covered in `gearStatus` - * @deprecated in SmartDeviceLink 7.0.0 - */ - @Deprecated - public UnsubscribeVehicleData setPrndl(Boolean prndl) { - setParameters(KEY_PRNDL, prndl); - return this; - } - - /** - * Gets the prndl. - * - * @return Boolean See PRNDL. This parameter is deprecated since SmartDeviceLink 7.0.0 and it is now covered in `gearStatus` - * @deprecated in SmartDeviceLink 7.0.0 - */ - @Deprecated - public Boolean getPrndl() { - return getBoolean(KEY_PRNDL); - } - - /** - * Sets a boolean value. If true, unsubscribes from tire pressure status data - * - * @param tirePressure a boolean value - */ - public UnsubscribeVehicleData setTirePressure(Boolean tirePressure) { - setParameters(KEY_TIRE_PRESSURE, tirePressure); - return this; - } - - /** - * Gets a boolean value. If true, means the tire pressure status data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the tire pressure status data - * has been unsubscribed. - */ - public Boolean getTirePressure() { - return getBoolean(KEY_TIRE_PRESSURE); - } - - /** - * Sets a boolean value. If true, unsubscribes from odometer data - * - * @param odometer a boolean value - */ - public UnsubscribeVehicleData setOdometer(Boolean odometer) { - setParameters(KEY_ODOMETER, odometer); - return this; - } - - /** - * Gets a boolean value. If true, means the odometer data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the odometer data - * has been unsubscribed. - */ - public Boolean getOdometer() { - return getBoolean(KEY_ODOMETER); - } - - /** - * Sets a boolean value. If true, unsubscribes from belt Status data - * - * @param beltStatus a boolean value - */ - public UnsubscribeVehicleData setBeltStatus(Boolean beltStatus) { - setParameters(KEY_BELT_STATUS, beltStatus); - return this; - } - - /** - * Gets a boolean value. If true, means the belt Status data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the belt Status data - * has been unsubscribed. - */ - public Boolean getBeltStatus() { - return getBoolean(KEY_BELT_STATUS); - } - - /** - * Sets a boolean value. If true, unsubscribes from body Information data - * - * @param bodyInformation a boolean value - */ - public UnsubscribeVehicleData setBodyInformation(Boolean bodyInformation) { - setParameters(KEY_BODY_INFORMATION, bodyInformation); - return this; - } - - /** - * Gets a boolean value. If true, means the body Information data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the body Information data - * has been unsubscribed. - */ - public Boolean getBodyInformation() { - return getBoolean(KEY_BODY_INFORMATION); - } - - /** - * Sets a boolean value. If true, unsubscribes from device Status data - * - * @param deviceStatus a boolean value - */ - public UnsubscribeVehicleData setDeviceStatus(Boolean deviceStatus) { - setParameters(KEY_DEVICE_STATUS, deviceStatus); - return this; - } - - /** - * Gets a boolean value. If true, means the device Status data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the device Status data - * has been unsubscribed. - */ - public Boolean getDeviceStatus() { - return getBoolean(KEY_DEVICE_STATUS); - } - - /** - * Sets a boolean value. If true, unsubscribes from driver Braking data - * - * @param driverBraking a boolean value - */ - public UnsubscribeVehicleData setDriverBraking(Boolean driverBraking) { - setParameters(KEY_DRIVER_BRAKING, driverBraking); - return this; - } - - /** - * Gets a boolean value. If true, means the driver Braking data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the driver Braking data - * has been unsubscribed. - */ - public Boolean getDriverBraking() { - return getBoolean(KEY_DRIVER_BRAKING); - } - - /** - * Sets a boolean value. If true, unsubscribes from wiper Status data - * - * @param wiperStatus a boolean value - */ - public UnsubscribeVehicleData setWiperStatus(Boolean wiperStatus) { - setParameters(KEY_WIPER_STATUS, wiperStatus); - return this; - } - - /** - * Gets a boolean value. If true, means the wiper Status data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the wiper Status data - * has been unsubscribed. - */ - public Boolean getWiperStatus() { - return getBoolean(KEY_WIPER_STATUS); - } - - /** - * Sets a boolean value. If true, unsubscribes from Head Lamp Status data - * - * @param headLampStatus a boolean value - */ - public UnsubscribeVehicleData setHeadLampStatus(Boolean headLampStatus) { - setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus); - return this; - } - - /** - * Gets a boolean value. If true, means the Head Lamp Status data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the Head Lamp Status data - * has been unsubscribed. - */ - public Boolean getHeadLampStatus() { - return getBoolean(KEY_HEAD_LAMP_STATUS); - } - - /** - * Sets a boolean value. If true, unsubscribes from Engine Torque data - * - * @param engineTorque a boolean value - */ - public UnsubscribeVehicleData setEngineTorque(Boolean engineTorque) { - setParameters(KEY_ENGINE_TORQUE, engineTorque); - return this; - } - - /** - * Gets a boolean value. If true, means the Engine Torque data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the Engine Torque data - * has been unsubscribed. - */ - public Boolean getEngineTorque() { - return getBoolean(KEY_ENGINE_TORQUE); - } - - /** - * Sets a boolean value. If true, unsubscribes from Engine Oil Life data - * - * @param engineOilLife a boolean value - */ - public UnsubscribeVehicleData setEngineOilLife(Boolean engineOilLife) { - setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife); - return this; - } - - /** - * Gets a boolean value. If true, means the Engine Oil Life data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the Engine Oil Life data - * has been unsubscribed. - */ - public Boolean getEngineOilLife() { - return getBoolean(KEY_ENGINE_OIL_LIFE); - } - - - /** - * Sets a boolean value. If true, unsubscribes from accPedalPosition data - * - * @param accPedalPosition a boolean value - */ - public UnsubscribeVehicleData setAccPedalPosition(Boolean accPedalPosition) { - setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition); - return this; - } - - /** - * Gets a boolean value. If true, means the accPedalPosition data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the accPedalPosition data - * has been unsubscribed. - */ - public Boolean getAccPedalPosition() { - return getBoolean(KEY_ACC_PEDAL_POSITION); - } - - public UnsubscribeVehicleData setSteeringWheelAngle(Boolean steeringWheelAngle) { - setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle); - return this; - } - - public Boolean getSteeringWheelAngle() { - return getBoolean(KEY_STEERING_WHEEL_ANGLE); - } - - public UnsubscribeVehicleData setECallInfo(Boolean eCallInfo) { - setParameters(KEY_E_CALL_INFO, eCallInfo); - return this; - } - - public Boolean getECallInfo() { - return getBoolean(KEY_E_CALL_INFO); - } - - public UnsubscribeVehicleData setAirbagStatus(Boolean airbagStatus) { - setParameters(KEY_AIRBAG_STATUS, airbagStatus); - return this; - } - - public Boolean getAirbagStatus() { - return getBoolean(KEY_AIRBAG_STATUS); - } - - public UnsubscribeVehicleData setEmergencyEvent(Boolean emergencyEvent) { - setParameters(KEY_EMERGENCY_EVENT, emergencyEvent); - return this; - } - - public Boolean getEmergencyEvent() { - return getBoolean(KEY_EMERGENCY_EVENT); - } - - public UnsubscribeVehicleData setClusterModeStatus(Boolean clusterModeStatus) { - setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus); - return this; - } - - public Boolean getClusterModeStatus() { - return getBoolean(KEY_CLUSTER_MODE_STATUS); - } - - public UnsubscribeVehicleData setMyKey(Boolean myKey) { - setParameters(KEY_MY_KEY, myKey); - return this; - } - - public Boolean getMyKey() { - return getBoolean(KEY_MY_KEY); - } - - /** - * Sets a boolean value. If true, unsubscribes from fuelRange data - * - * @param fuelRange a boolean value - */ - public UnsubscribeVehicleData setFuelRange(Boolean fuelRange) { - setParameters(KEY_FUEL_RANGE, fuelRange); - return this; - } - - /** - * Gets a boolean value. If true, means the fuelRange data has been - * unsubscribed. - * - * @return Boolean -a Boolean value. If true, means the fuelRange data - * has been unsubscribed. - */ - public Boolean getFuelRange() { - return getBoolean(KEY_FUEL_RANGE); - } - - /** - * Sets a boolean value. If true, unsubscribes from turnSignal data - * - * @param turnSignal a boolean value - */ - public UnsubscribeVehicleData setTurnSignal(Boolean turnSignal) { - setParameters(KEY_TURN_SIGNAL, turnSignal); - return this; - } - - /** - * Gets a boolean value. If true, means the turnSignal data has been unsubscribed. - * - * @return a Boolean value. - */ - public Boolean getTurnSignal() { - return getBoolean(KEY_TURN_SIGNAL); - } - - /** - * Sets a boolean value. If true, unsubscribes from electronicParkBrakeStatus data - * - * @param electronicParkBrakeStatus a boolean value - */ - public UnsubscribeVehicleData setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus) { - setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus); - return this; - } - - /** - * Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed. - * - * @return a Boolean value. - */ - public Boolean getElectronicParkBrakeStatus() { - return getBoolean(KEY_ELECTRONIC_PARK_BRAKE_STATUS); - } - - /** - * Sets a boolean value. If true, unsubscribes from cloudAppVehicleID data - * - * @param cloudAppVehicleID a boolean value. - */ - public UnsubscribeVehicleData setCloudAppVehicleID(boolean cloudAppVehicleID) { - setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID); - return this; - } - - /** - * Gets a boolean value. If true, means the cloudAppVehicleID data has been unsubscribed. - * - * @return a Boolean value. - */ - public Boolean getCloudAppVehicleID() { - return getBoolean(KEY_CLOUD_APP_VEHICLE_ID); - } - - /** - * Sets a boolean value for OEM Custom VehicleData. - * - * @param vehicleDataName a String value - * @param vehicleDataState a boolean value - */ - public UnsubscribeVehicleData setOEMCustomVehicleData(String vehicleDataName, Boolean vehicleDataState) { - setParameters(vehicleDataName, vehicleDataState); - return this; - } - - /** - * Gets a boolean value for OEM Custom VehicleData. - * - * @return a Boolean value. - */ - public Boolean getOEMCustomVehicleData(String vehicleDataName) { - return getBoolean(vehicleDataName); - } - - /** - * Sets the gearStatus. - * - * @param gearStatus See GearStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleData setGearStatus(Boolean gearStatus) { - setParameters(KEY_GEAR_STATUS, gearStatus); - return this; - } - - /** - * Gets the gearStatus. - * - * @return Boolean See GearStatus - * @since SmartDeviceLink 7.0.0 - */ - public Boolean getGearStatus() { - return getBoolean(KEY_GEAR_STATUS); - } - - /** - * Sets the handsOffSteering. - * - * @param handsOffSteering To indicate whether driver hands are off the steering wheel - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleData setHandsOffSteering(Boolean handsOffSteering) { - setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering); - return this; - } - - /** - * Gets the handsOffSteering. - * - * @return Boolean To indicate whether driver hands are off the steering wheel - * @since SmartDeviceLink 7.0.0 - */ - public Boolean getHandsOffSteering() { - return getBoolean(KEY_HANDS_OFF_STEERING); - } - - /** - * Sets the windowStatus. - * - * @param windowStatus See WindowStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleData setWindowStatus(Boolean windowStatus) { - setParameters(KEY_WINDOW_STATUS, windowStatus); - return this; - } - - /** - * Gets the windowStatus. - * - * @return Boolean See WindowStatus - * @since SmartDeviceLink 7.0.0 - */ - public Boolean getWindowStatus() { - return getBoolean(KEY_WINDOW_STATUS); - } - - /** - * Sets the stabilityControlsStatus. - * - * @param stabilityControlsStatus See StabilityControlsStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleData setStabilityControlsStatus(Boolean stabilityControlsStatus) { - setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus); - return this; - } - - /** - * Gets the stabilityControlsStatus. - * - * @return Boolean See StabilityControlsStatus - * @since SmartDeviceLink 7.0.0 - */ - public Boolean getStabilityControlsStatus() { - return getBoolean(KEY_STABILITY_CONTROLS_STATUS); - } - - /** - * Sets the seatOccupancy. - * - * @param seatOccupancy See SeatOccupancy - * @since SmartDeviceLink 7.1.0 - */ - public UnsubscribeVehicleData setSeatOccupancy(Boolean seatOccupancy) { - setParameters(KEY_SEAT_OCCUPANCY, seatOccupancy); - return this; - } - - /** - * Gets the seatOccupancy. - * - * @return Boolean See SeatOccupancy - * @since SmartDeviceLink 7.1.0 - */ - public Boolean getSeatOccupancy() { - return getBoolean(KEY_SEAT_OCCUPANCY); - } -} +/*
+ * 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;
+
+/**
+ * This function is used to unsubscribe the notifications from the
+ * subscribeVehicleData function
+ * <p>Function Group: Location, VehicleInfo and DrivingChara</p>
+ * <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
+ *
+ * <p><b>Parameter List</b></p>
+ * <table border="1" rules="all">
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>Reg.</th>
+ * <th>Notes</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelRange</td>
+ * <td>Boolean</td>
+ * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in micro litres</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>gearStatus</td>
+ * <td>Boolean</td>
+ * <td>See GearStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
+ * <td>N</td>
+ * <td>Max Length: 500</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineOilLife</td>
+ * <td>Boolean</td>
+ * <td>The estimated percentage of remaining oil life of the engine</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>turnSignal</td>
+ * <td>Boolean</td>
+ * <td>@see TurnSignal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
+ * <tr>
+ * <td>handsOffSteering</td>
+ * <td>Boolean</td>
+ * <td>To indicate whether driver hands are off the steering wheel</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>windowStatus</td>
+ * <td>Boolean</td>
+ * <td>See WindowStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>stabilityControlsStatus</td>
+ * <td>Boolean</td>
+ * <td>See StabilityControlsStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>seatOccupancy</td>
+ * <td>Boolean</td>
+ * <td>See SeatOccupancy</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ *
+ *
+ * </table>
+ * <p><b> Response</b></p>
+ * <p><b>Non-default Result Codes:</b></p>
+ * <p>SUCCESS</p>
+ * <p>WARNINGS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED</p>
+ * <p>DISALLOWED</p>
+ *
+ * @see SubscribeVehicleData
+ * @see GetVehicleData
+ * @since SmartDeviceLink 2.0
+ */
+public class UnsubscribeVehicleData extends RPCRequest {
+ public static final String KEY_SPEED = "speed";
+ public static final String KEY_RPM = "rpm";
+ public static final String KEY_EXTERNAL_TEMPERATURE = "externalTemperature";
+ public static final String KEY_PRNDL = "prndl";
+ public static final String KEY_TIRE_PRESSURE = "tirePressure";
+ public static final String KEY_ENGINE_TORQUE = "engineTorque";
+ public static final String KEY_ENGINE_OIL_LIFE = "engineOilLife";
+ public static final String KEY_ODOMETER = "odometer";
+ public static final String KEY_GPS = "gps";
+ public static final String KEY_INSTANT_FUEL_CONSUMPTION = "instantFuelConsumption";
+ public static final String KEY_BELT_STATUS = "beltStatus";
+ public static final String KEY_BODY_INFORMATION = "bodyInformation";
+ public static final String KEY_DEVICE_STATUS = "deviceStatus";
+ public static final String KEY_DRIVER_BRAKING = "driverBraking";
+ public static final String KEY_WIPER_STATUS = "wiperStatus";
+ public static final String KEY_HEAD_LAMP_STATUS = "headLampStatus";
+ public static final String KEY_ACC_PEDAL_POSITION = "accPedalPosition";
+ public static final String KEY_STEERING_WHEEL_ANGLE = "steeringWheelAngle";
+ public static final String KEY_E_CALL_INFO = "eCallInfo";
+ public static final String KEY_AIRBAG_STATUS = "airbagStatus";
+ public static final String KEY_EMERGENCY_EVENT = "emergencyEvent";
+ public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus";
+ public static final String KEY_MY_KEY = "myKey";
+ public static final String KEY_FUEL_RANGE = "fuelRange";
+ public static final String KEY_TURN_SIGNAL = "turnSignal";
+ public static final String KEY_ELECTRONIC_PARK_BRAKE_STATUS = "electronicParkBrakeStatus";
+ public static final String KEY_CLOUD_APP_VEHICLE_ID = "cloudAppVehicleID";
+ public static final String KEY_HANDS_OFF_STEERING = "handsOffSteering";
+ public static final String KEY_GEAR_STATUS = "gearStatus";
+ public static final String KEY_WINDOW_STATUS = "windowStatus";
+ /**
+ * @deprecated
+ */
+ @Deprecated
+ public static final String KEY_FUEL_LEVEL = "fuelLevel";
+ /**
+ * @deprecated
+ */
+ @Deprecated
+ public static final String KEY_FUEL_LEVEL_STATE = "fuelLevel_State";
+ public static final String KEY_STABILITY_CONTROLS_STATUS = "stabilityControlsStatus";
+ /**
+ * @since SmartDeviceLink 7.1.0
+ */
+ public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy";
+
+ /**
+ * Constructs a new UnsubscribeVehicleData object
+ */
+ public UnsubscribeVehicleData() {
+ super(FunctionID.UNSUBSCRIBE_VEHICLE_DATA.toString());
+ }
+
+ /**
+ * Constructs a new UnsubscribeVehicleData object indicated by the Hashtable
+ * parameter
+ * <p></p>
+ *
+ * @param hash The Hashtable to use
+ */
+ public UnsubscribeVehicleData(Hashtable<String, Object> hash) {
+ super(hash);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from Gps data
+ *
+ * @param gps a boolean value
+ */
+ public UnsubscribeVehicleData setGps(Boolean gps) {
+ setParameters(KEY_GPS, gps);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the Gps data has been unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the Gps data has been
+ * unsubscribed.
+ */
+ public Boolean getGps() {
+ return getBoolean(KEY_GPS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from speed data
+ *
+ * @param speed a boolean value
+ */
+ public UnsubscribeVehicleData setSpeed(Boolean speed) {
+ setParameters(KEY_SPEED, speed);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the Speed data has been unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the Speed data has been
+ * unsubscribed.
+ */
+ public Boolean getSpeed() {
+ return getBoolean(KEY_SPEED);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribe data
+ *
+ * @param rpm a boolean value
+ */
+ public UnsubscribeVehicleData setRpm(Boolean rpm) {
+ setParameters(KEY_RPM, rpm);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the rpm data has been unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the rpm data has been
+ * unsubscribed.
+ */
+ public Boolean getRpm() {
+ return getBoolean(KEY_RPM);
+ }
+
+ /**
+ * Sets the fuelLevel.
+ *
+ * @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
+ * 7.0, please see fuelRange.
+ */
+ @Deprecated
+ public UnsubscribeVehicleData setFuelLevel(Boolean fuelLevel) {
+ setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
+ }
+
+ /**
+ * Gets the fuelLevel.
+ *
+ * @return Boolean The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
+ * 7.0, please see fuelRange.
+ */
+ @Deprecated
+ public Boolean getFuelLevel() {
+ return getBoolean(KEY_FUEL_LEVEL);
+ }
+
+ /**
+ * Sets the fuelRange.
+ *
+ * @param fuelLevelState The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the
+ * vehicle. See struct FuelRange for details.
+ * @since SmartDeviceLink 5.0.0
+ */
+ @Deprecated
+ public UnsubscribeVehicleData setFuelLevelState(Boolean fuelLevelState) {
+ setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
+ }
+
+ /**
+ * Gets the fuelRange.
+ *
+ * @return Boolean The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the
+ * vehicle. See struct FuelRange for details.
+ * @since SmartDeviceLink 5.0.0
+ */
+ @Deprecated
+ public Boolean getFuelLevelState() {
+ return getBoolean(KEY_FUEL_LEVEL_STATE);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from instantFuelConsumption data
+ *
+ * @param instantFuelConsumption a boolean value
+ */
+ public UnsubscribeVehicleData setInstantFuelConsumption(Boolean instantFuelConsumption) {
+ setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the getInstantFuelConsumption data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the getInstantFuelConsumption data
+ * has been unsubscribed.
+ */
+ public Boolean getInstantFuelConsumption() {
+ return getBoolean(KEY_INSTANT_FUEL_CONSUMPTION);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from externalTemperature data
+ *
+ * @param externalTemperature a boolean value
+ */
+ public UnsubscribeVehicleData setExternalTemperature(Boolean externalTemperature) {
+ setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the externalTemperature data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the externalTemperature data
+ * has been unsubscribed.
+ */
+ public Boolean getExternalTemperature() {
+ return getBoolean(KEY_EXTERNAL_TEMPERATURE);
+ }
+
+ /**
+ * Sets the prndl.
+ *
+ * @param prndl See PRNDL. This parameter since SmartDeviceLink 7.0.0 is deprecated and it is now covered in `gearStatus`
+ * @deprecated in SmartDeviceLink 7.0.0
+ */
+ @Deprecated
+ public UnsubscribeVehicleData setPrndl(Boolean prndl) {
+ setParameters(KEY_PRNDL, prndl);
+ return this;
+ }
+
+ /**
+ * Gets the prndl.
+ *
+ * @return Boolean See PRNDL. This parameter is deprecated since SmartDeviceLink 7.0.0 and it is now covered in `gearStatus`
+ * @deprecated in SmartDeviceLink 7.0.0
+ */
+ @Deprecated
+ public Boolean getPrndl() {
+ return getBoolean(KEY_PRNDL);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from tire pressure status data
+ *
+ * @param tirePressure a boolean value
+ */
+ public UnsubscribeVehicleData setTirePressure(Boolean tirePressure) {
+ setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the tire pressure status data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the tire pressure status data
+ * has been unsubscribed.
+ */
+ public Boolean getTirePressure() {
+ return getBoolean(KEY_TIRE_PRESSURE);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from odometer data
+ *
+ * @param odometer a boolean value
+ */
+ public UnsubscribeVehicleData setOdometer(Boolean odometer) {
+ setParameters(KEY_ODOMETER, odometer);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the odometer data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the odometer data
+ * has been unsubscribed.
+ */
+ public Boolean getOdometer() {
+ return getBoolean(KEY_ODOMETER);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from belt Status data
+ *
+ * @param beltStatus a boolean value
+ */
+ public UnsubscribeVehicleData setBeltStatus(Boolean beltStatus) {
+ setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the belt Status data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the belt Status data
+ * has been unsubscribed.
+ */
+ public Boolean getBeltStatus() {
+ return getBoolean(KEY_BELT_STATUS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from body Information data
+ *
+ * @param bodyInformation a boolean value
+ */
+ public UnsubscribeVehicleData setBodyInformation(Boolean bodyInformation) {
+ setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the body Information data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the body Information data
+ * has been unsubscribed.
+ */
+ public Boolean getBodyInformation() {
+ return getBoolean(KEY_BODY_INFORMATION);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from device Status data
+ *
+ * @param deviceStatus a boolean value
+ */
+ public UnsubscribeVehicleData setDeviceStatus(Boolean deviceStatus) {
+ setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the device Status data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the device Status data
+ * has been unsubscribed.
+ */
+ public Boolean getDeviceStatus() {
+ return getBoolean(KEY_DEVICE_STATUS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from driver Braking data
+ *
+ * @param driverBraking a boolean value
+ */
+ public UnsubscribeVehicleData setDriverBraking(Boolean driverBraking) {
+ setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the driver Braking data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the driver Braking data
+ * has been unsubscribed.
+ */
+ public Boolean getDriverBraking() {
+ return getBoolean(KEY_DRIVER_BRAKING);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from wiper Status data
+ *
+ * @param wiperStatus a boolean value
+ */
+ public UnsubscribeVehicleData setWiperStatus(Boolean wiperStatus) {
+ setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the wiper Status data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the wiper Status data
+ * has been unsubscribed.
+ */
+ public Boolean getWiperStatus() {
+ return getBoolean(KEY_WIPER_STATUS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from Head Lamp Status data
+ *
+ * @param headLampStatus a boolean value
+ */
+ public UnsubscribeVehicleData setHeadLampStatus(Boolean headLampStatus) {
+ setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the Head Lamp Status data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the Head Lamp Status data
+ * has been unsubscribed.
+ */
+ public Boolean getHeadLampStatus() {
+ return getBoolean(KEY_HEAD_LAMP_STATUS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from Engine Torque data
+ *
+ * @param engineTorque a boolean value
+ */
+ public UnsubscribeVehicleData setEngineTorque(Boolean engineTorque) {
+ setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the Engine Torque data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the Engine Torque data
+ * has been unsubscribed.
+ */
+ public Boolean getEngineTorque() {
+ return getBoolean(KEY_ENGINE_TORQUE);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from Engine Oil Life data
+ *
+ * @param engineOilLife a boolean value
+ */
+ public UnsubscribeVehicleData setEngineOilLife(Boolean engineOilLife) {
+ setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the Engine Oil Life data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the Engine Oil Life data
+ * has been unsubscribed.
+ */
+ public Boolean getEngineOilLife() {
+ return getBoolean(KEY_ENGINE_OIL_LIFE);
+ }
+
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from accPedalPosition data
+ *
+ * @param accPedalPosition a boolean value
+ */
+ public UnsubscribeVehicleData setAccPedalPosition(Boolean accPedalPosition) {
+ setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the accPedalPosition data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the accPedalPosition data
+ * has been unsubscribed.
+ */
+ public Boolean getAccPedalPosition() {
+ return getBoolean(KEY_ACC_PEDAL_POSITION);
+ }
+
+ public UnsubscribeVehicleData setSteeringWheelAngle(Boolean steeringWheelAngle) {
+ setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
+ }
+
+ public Boolean getSteeringWheelAngle() {
+ return getBoolean(KEY_STEERING_WHEEL_ANGLE);
+ }
+
+ public UnsubscribeVehicleData setECallInfo(Boolean eCallInfo) {
+ setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
+ }
+
+ public Boolean getECallInfo() {
+ return getBoolean(KEY_E_CALL_INFO);
+ }
+
+ public UnsubscribeVehicleData setAirbagStatus(Boolean airbagStatus) {
+ setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
+ }
+
+ public Boolean getAirbagStatus() {
+ return getBoolean(KEY_AIRBAG_STATUS);
+ }
+
+ public UnsubscribeVehicleData setEmergencyEvent(Boolean emergencyEvent) {
+ setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
+ }
+
+ public Boolean getEmergencyEvent() {
+ return getBoolean(KEY_EMERGENCY_EVENT);
+ }
+
+ public UnsubscribeVehicleData setClusterModeStatus(Boolean clusterModeStatus) {
+ setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
+ }
+
+ public Boolean getClusterModeStatus() {
+ return getBoolean(KEY_CLUSTER_MODE_STATUS);
+ }
+
+ public UnsubscribeVehicleData setMyKey(Boolean myKey) {
+ setParameters(KEY_MY_KEY, myKey);
+ return this;
+ }
+
+ public Boolean getMyKey() {
+ return getBoolean(KEY_MY_KEY);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from fuelRange data
+ *
+ * @param fuelRange a boolean value
+ */
+ public UnsubscribeVehicleData setFuelRange(Boolean fuelRange) {
+ setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the fuelRange data has been
+ * unsubscribed.
+ *
+ * @return Boolean -a Boolean value. If true, means the fuelRange data
+ * has been unsubscribed.
+ */
+ public Boolean getFuelRange() {
+ return getBoolean(KEY_FUEL_RANGE);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from turnSignal data
+ *
+ * @param turnSignal a boolean value
+ */
+ public UnsubscribeVehicleData setTurnSignal(Boolean turnSignal) {
+ setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the turnSignal data has been unsubscribed.
+ *
+ * @return a Boolean value.
+ */
+ public Boolean getTurnSignal() {
+ return getBoolean(KEY_TURN_SIGNAL);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from electronicParkBrakeStatus data
+ *
+ * @param electronicParkBrakeStatus a boolean value
+ */
+ public UnsubscribeVehicleData setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus) {
+ setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.
+ *
+ * @return a Boolean value.
+ */
+ public Boolean getElectronicParkBrakeStatus() {
+ return getBoolean(KEY_ELECTRONIC_PARK_BRAKE_STATUS);
+ }
+
+ /**
+ * Sets a boolean value. If true, unsubscribes from cloudAppVehicleID data
+ *
+ * @param cloudAppVehicleID a boolean value.
+ */
+ public UnsubscribeVehicleData setCloudAppVehicleID(boolean cloudAppVehicleID) {
+ setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value. If true, means the cloudAppVehicleID data has been unsubscribed.
+ *
+ * @return a Boolean value.
+ */
+ public Boolean getCloudAppVehicleID() {
+ return getBoolean(KEY_CLOUD_APP_VEHICLE_ID);
+ }
+
+ /**
+ * Sets a boolean value for OEM Custom VehicleData.
+ *
+ * @param vehicleDataName a String value
+ * @param vehicleDataState a boolean value
+ */
+ public UnsubscribeVehicleData setOEMCustomVehicleData(String vehicleDataName, Boolean vehicleDataState) {
+ setParameters(vehicleDataName, vehicleDataState);
+ return this;
+ }
+
+ /**
+ * Gets a boolean value for OEM Custom VehicleData.
+ *
+ * @return a Boolean value.
+ */
+ public Boolean getOEMCustomVehicleData(String vehicleDataName) {
+ return getBoolean(vehicleDataName);
+ }
+
+ /**
+ * Sets the gearStatus.
+ *
+ * @param gearStatus See GearStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleData setGearStatus(Boolean gearStatus) {
+ setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
+ }
+
+ /**
+ * Gets the gearStatus.
+ *
+ * @return Boolean See GearStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public Boolean getGearStatus() {
+ return getBoolean(KEY_GEAR_STATUS);
+ }
+
+ /**
+ * Sets the handsOffSteering.
+ *
+ * @param handsOffSteering To indicate whether driver hands are off the steering wheel
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleData setHandsOffSteering(Boolean handsOffSteering) {
+ setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
+ }
+
+ /**
+ * Gets the handsOffSteering.
+ *
+ * @return Boolean To indicate whether driver hands are off the steering wheel
+ * @since SmartDeviceLink 7.0.0
+ */
+ public Boolean getHandsOffSteering() {
+ return getBoolean(KEY_HANDS_OFF_STEERING);
+ }
+
+ /**
+ * Sets the windowStatus.
+ *
+ * @param windowStatus See WindowStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleData setWindowStatus(Boolean windowStatus) {
+ setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
+ }
+
+ /**
+ * Gets the windowStatus.
+ *
+ * @return Boolean See WindowStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public Boolean getWindowStatus() {
+ return getBoolean(KEY_WINDOW_STATUS);
+ }
+
+ /**
+ * Sets the stabilityControlsStatus.
+ *
+ * @param stabilityControlsStatus See StabilityControlsStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleData setStabilityControlsStatus(Boolean stabilityControlsStatus) {
+ setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
+ }
+
+ /**
+ * Gets the stabilityControlsStatus.
+ *
+ * @return Boolean See StabilityControlsStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public Boolean getStabilityControlsStatus() {
+ return getBoolean(KEY_STABILITY_CONTROLS_STATUS);
+ }
+
+ /**
+ * Sets the seatOccupancy.
+ *
+ * @param seatOccupancy See SeatOccupancy
+ * @since SmartDeviceLink 7.1.0
+ */
+ public UnsubscribeVehicleData setSeatOccupancy(Boolean seatOccupancy) {
+ setParameters(KEY_SEAT_OCCUPANCY, seatOccupancy);
+ return this;
+ }
+
+ /**
+ * Gets the seatOccupancy.
+ *
+ * @return Boolean See SeatOccupancy
+ * @since SmartDeviceLink 7.1.0
+ */
+ public Boolean getSeatOccupancy() {
+ return getBoolean(KEY_SEAT_OCCUPANCY);
+ }
+}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java index b00b06dde..5d6434608 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java @@ -1,780 +1,780 @@ -/* - * 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.protocol.enums.FunctionID; -import com.smartdevicelink.proxy.RPCResponse; -import com.smartdevicelink.proxy.rpc.enums.Result; - -import java.util.Hashtable; - -/** - * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called. - * - * @since SmartDeviceLink 2.0 - */ -public class UnsubscribeVehicleDataResponse extends RPCResponse { - public static final String KEY_SPEED = "speed"; - public static final String KEY_RPM = "rpm"; - public static final String KEY_EXTERNAL_TEMPERATURE = "externalTemperature"; - public static final String KEY_PRNDL = "prndl"; - public static final String KEY_TIRE_PRESSURE = "tirePressure"; - public static final String KEY_ENGINE_TORQUE = "engineTorque"; - public static final String KEY_ENGINE_OIL_LIFE = "engineOilLife"; - public static final String KEY_ODOMETER = "odometer"; - public static final String KEY_GPS = "gps"; - public static final String KEY_INSTANT_FUEL_CONSUMPTION = "instantFuelConsumption"; - public static final String KEY_BELT_STATUS = "beltStatus"; - public static final String KEY_BODY_INFORMATION = "bodyInformation"; - public static final String KEY_DEVICE_STATUS = "deviceStatus"; - public static final String KEY_DRIVER_BRAKING = "driverBraking"; - public static final String KEY_WIPER_STATUS = "wiperStatus"; - public static final String KEY_HEAD_LAMP_STATUS = "headLampStatus"; - public static final String KEY_ACC_PEDAL_POSITION = "accPedalPosition"; - public static final String KEY_STEERING_WHEEL_ANGLE = "steeringWheelAngle"; - public static final String KEY_E_CALL_INFO = "eCallInfo"; - public static final String KEY_AIRBAG_STATUS = "airbagStatus"; - public static final String KEY_EMERGENCY_EVENT = "emergencyEvent"; - @Deprecated - public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus"; - public static final String KEY_CLUSTER_MODES = "clusterModes"; - public static final String KEY_MY_KEY = "myKey"; - public static final String KEY_FUEL_RANGE = "fuelRange"; - public static final String KEY_TURN_SIGNAL = "turnSignal"; - public static final String KEY_ELECTRONIC_PARK_BRAKE_STATUS = "electronicParkBrakeStatus"; - public static final String KEY_CLOUD_APP_VEHICLE_ID = "cloudAppVehicleID"; - public static final String KEY_HANDS_OFF_STEERING = "handsOffSteering"; - public static final String KEY_WINDOW_STATUS = "windowStatus"; - public static final String KEY_GEAR_STATUS = "gearStatus"; - /** - * @deprecated - */ - @Deprecated - public static final String KEY_FUEL_LEVEL = "fuelLevel"; - /** - * @deprecated - */ - @Deprecated - public static final String KEY_FUEL_LEVEL_STATE = "fuelLevel_State"; - public static final String KEY_STABILITY_CONTROLS_STATUS = "stabilityControlsStatus"; - /** - * @since SmartDeviceLink 7.1.0 - */ - public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy"; - /** - * Constructs a new UnsubscribeVehicleDataResponse object - */ - public UnsubscribeVehicleDataResponse() { - super(FunctionID.UNSUBSCRIBE_VEHICLE_DATA.toString()); - } - - /** - * Constructs a new UnsubscribeVehicleDataResponse object - * - * @param success whether the request is successfully processed - * @param resultCode whether the request is successfully processed - */ - public UnsubscribeVehicleDataResponse(@NonNull Boolean success, @NonNull Result resultCode) { - this(); - setSuccess(success); - setResultCode(resultCode); - } - - /** - * Constructs a new UnsubscribeVehicleDataResponse object indicated by the Hashtable - * parameter - * <p></p> - * - * @param hash The Hashtable to use to build this RPC - */ - public UnsubscribeVehicleDataResponse(Hashtable<String, Object> hash) { - super(hash); - } - - /** - * Sets Gps - * - * @param gps a VehicleDataResult related to GPS - */ - public UnsubscribeVehicleDataResponse setGps(VehicleDataResult gps) { - setParameters(KEY_GPS, gps); - return this; - } - - /** - * Gets Gps - * - * @return a VehicleDataResult related to GPS - */ - public VehicleDataResult getGps() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_GPS); - } - - /** - * Sets Speed - * - * @param speed a VehicleDataResult related to speed - */ - public UnsubscribeVehicleDataResponse setSpeed(VehicleDataResult speed) { - setParameters(KEY_SPEED, speed); - return this; - } - - /** - * Gets Speed - * - * @return a VehicleDataResult related to speed - */ - public VehicleDataResult getSpeed() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_SPEED); - } - - /** - * Sets rpm - * - * @param rpm a VehicleDataResult related to RPM - */ - public UnsubscribeVehicleDataResponse setRpm(VehicleDataResult rpm) { - setParameters(KEY_RPM, rpm); - return this; - } - - /** - * Gets rpm - * - * @return a VehicleDataResult related to RPM - */ - public VehicleDataResult getRpm() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_RPM); - } - - /** - * Sets the fuelLevel. - * - * @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec - * 7.0, please see fuelRange. - */ - @Deprecated - public UnsubscribeVehicleDataResponse setFuelLevel(VehicleDataResult fuelLevel) { - setParameters(KEY_FUEL_LEVEL, fuelLevel); - return this; - } - - /** - * Gets the fuelLevel. - * - * @return VehicleDataResult The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec - * 7.0, please see fuelRange. - */ - @Deprecated - public VehicleDataResult getFuelLevel() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_LEVEL); - } - - /** - * Sets Fuel Level State - * - * @param fuelLevelState a VehicleDataResult related to FuelLevel State - */ - @Deprecated - public UnsubscribeVehicleDataResponse setFuelLevelState(VehicleDataResult fuelLevelState) { - setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState); - return this; - } - - /** - * Gets Fuel Level State - * - * @return a VehicleDataResult related to FuelLevel State - */ - @Deprecated - public VehicleDataResult getFuelLevelState() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_LEVEL_STATE); - } - - /** - * Sets Instant Fuel Consumption - * - * @param instantFuelConsumption a VehicleDataResult related to instant fuel consumption - */ - public UnsubscribeVehicleDataResponse setInstantFuelConsumption(VehicleDataResult instantFuelConsumption) { - setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption); - return this; - } - - /** - * Gets Instant Fuel Consumption - * - * @return a VehicleDataResult related to instant fuel consumption - */ - public VehicleDataResult getInstantFuelConsumption() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_INSTANT_FUEL_CONSUMPTION); - } - - /** - * Sets External Temperature - * - * @param externalTemperature a VehicleDataResult related to external temperature - */ - public UnsubscribeVehicleDataResponse setExternalTemperature(VehicleDataResult externalTemperature) { - setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature); - return this; - } - - /** - * Gets External Temperature - * - * @return a VehicleDataResult related to external temperature - */ - public VehicleDataResult getExternalTemperature() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EXTERNAL_TEMPERATURE); - } - - /** - * Sets the prndl. - * - * @param prndl See PRNDL. - * @deprecated in SmartDeviceLink 7.0.0 - */ - @Deprecated - public UnsubscribeVehicleDataResponse setPrndl(VehicleDataResult prndl) { - setParameters(KEY_PRNDL, prndl); - return this; - } - - /** - * Gets the prndl. - * - * @return VehicleDataResult. - * @deprecated in SmartDeviceLink 7.0.0 - */ - @Deprecated - public VehicleDataResult getPrndl() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_PRNDL); - } - - /** - * Sets Tire Pressure - * - * @param tirePressure a VehicleDataResult related to tire pressure - */ - public UnsubscribeVehicleDataResponse setTirePressure(VehicleDataResult tirePressure) { - setParameters(KEY_TIRE_PRESSURE, tirePressure); - return this; - } - - /** - * Gets Tire Pressure - * - * @return a VehicleDataResult related to tire pressure - */ - public VehicleDataResult getTirePressure() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_TIRE_PRESSURE); - } - - /** - * Sets Odometer - * - * @param odometer a VehicleDataResult related to the odometer - */ - public UnsubscribeVehicleDataResponse setOdometer(VehicleDataResult odometer) { - setParameters(KEY_ODOMETER, odometer); - return this; - } - - /** - * Gets Odometer - * - * @return a VehicleDataResult related to the odometer - */ - public VehicleDataResult getOdometer() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ODOMETER); - } - - /** - * Sets Belt Status - * - * @param beltStatus a VehicleDataResult related to the seat belt status - */ - public UnsubscribeVehicleDataResponse setBeltStatus(VehicleDataResult beltStatus) { - setParameters(KEY_BELT_STATUS, beltStatus); - return this; - } - - /** - * Gets Belt Status - * - * @return a VehicleDataResult related to the seat belt status - */ - public VehicleDataResult getBeltStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_BELT_STATUS); - } - - /** - * Sets Body Information - * - * @param bodyInformation a VehicleDataResult related to the body info - */ - public UnsubscribeVehicleDataResponse setBodyInformation(VehicleDataResult bodyInformation) { - setParameters(KEY_BODY_INFORMATION, bodyInformation); - return this; - } - - /** - * Gets Body Information - * - * @return a VehicleDataResult related to the body info - */ - public VehicleDataResult getBodyInformation() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_BODY_INFORMATION); - } - - /** - * Sets Device Status - * - * @param deviceStatus a VehicleDataResult related to the device status of the connected device - */ - public UnsubscribeVehicleDataResponse setDeviceStatus(VehicleDataResult deviceStatus) { - setParameters(KEY_DEVICE_STATUS, deviceStatus); - return this; - } - - /** - * Gets Device Status - * - * @return a VehicleDataResult related to the device status of the connected device - */ - public VehicleDataResult getDeviceStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_DEVICE_STATUS); - } - - /** - * Sets Driver Braking - * - * @param driverBraking a VehicleDataResult related to the driver breaking status - */ - public UnsubscribeVehicleDataResponse setDriverBraking(VehicleDataResult driverBraking) { - setParameters(KEY_DRIVER_BRAKING, driverBraking); - return this; - } - - /** - * Gets Driver Braking - * - * @return a VehicleDataResult related to the driver breaking status - */ - public VehicleDataResult getDriverBraking() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_DRIVER_BRAKING); - } - - /** - * Sets Wiper Status - * - * @param wiperStatus a VehicleDataResult related to the wiper status - */ - public UnsubscribeVehicleDataResponse setWiperStatus(VehicleDataResult wiperStatus) { - setParameters(KEY_WIPER_STATUS, wiperStatus); - return this; - } - - /** - * Gets Wiper Status - * - * @return a VehicleDataResult related to the wiper status - */ - public VehicleDataResult getWiperStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_WIPER_STATUS); - } - - /** - * Sets Head Lamp Status - * - * @param headLampStatus a VehicleDataResult related to the headlamp status - */ - public UnsubscribeVehicleDataResponse setHeadLampStatus(VehicleDataResult headLampStatus) { - setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus); - return this; - } - - /** - * Gets Head Lamp Status - * - * @return a VehicleDataResult related to the headlamp status - */ - public VehicleDataResult getHeadLampStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_HEAD_LAMP_STATUS); - } - - /** - * Sets Engine Torque - * - * @param engineTorque a VehicleDataResult related to the engine's torque - */ - public UnsubscribeVehicleDataResponse setEngineTorque(VehicleDataResult engineTorque) { - setParameters(KEY_ENGINE_TORQUE, engineTorque); - return this; - } - - /** - * Gets Engine Torque - * - * @return a VehicleDataResult related to the engine's torque - */ - public VehicleDataResult getEngineTorque() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ENGINE_TORQUE); - } - - /** - * Sets Engine Oil Life - * - * @param engineOilLife a VehicleDataResult related to the engine's oil life - */ - public UnsubscribeVehicleDataResponse setEngineOilLife(VehicleDataResult engineOilLife) { - setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife); - return this; - } - - /** - * Gets Engine Oil Life - * - * @return a VehicleDataResult related to the engine's oil life - */ - public VehicleDataResult getEngineOilLife() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ENGINE_OIL_LIFE); - } - - /** - * Sets AccPedal Position - * - * @param accPedalPosition a VehicleDataResult related to the accelerator pedal's position - */ - public UnsubscribeVehicleDataResponse setAccPedalPosition(VehicleDataResult accPedalPosition) { - setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition); - return this; - } - - /** - * Gets AccPedal Position - * - * @return a VehicleDataResult related to the accelerator pedal's position - */ - public VehicleDataResult getAccPedalPosition() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ACC_PEDAL_POSITION); - } - - public UnsubscribeVehicleDataResponse setSteeringWheelAngle(VehicleDataResult steeringWheelAngle) { - setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle); - return this; - } - - public VehicleDataResult getSteeringWheelAngle() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STEERING_WHEEL_ANGLE); - } - - public UnsubscribeVehicleDataResponse setECallInfo(VehicleDataResult eCallInfo) { - setParameters(KEY_E_CALL_INFO, eCallInfo); - return this; - } - - public VehicleDataResult getECallInfo() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_E_CALL_INFO); - } - - public UnsubscribeVehicleDataResponse setAirbagStatus(VehicleDataResult airbagStatus) { - setParameters(KEY_AIRBAG_STATUS, airbagStatus); - return this; - } - - public VehicleDataResult getAirbagStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_AIRBAG_STATUS); - } - - public UnsubscribeVehicleDataResponse setEmergencyEvent(VehicleDataResult emergencyEvent) { - setParameters(KEY_EMERGENCY_EVENT, emergencyEvent); - return this; - } - - public VehicleDataResult getEmergencyEvent() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT); - } - - /** - * @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead. - */ - @Deprecated - public UnsubscribeVehicleDataResponse setClusterModeStatus(VehicleDataResult clusterModeStatus) { - return setClusterModes(clusterModeStatus); - } - - /** - * @deprecated use {@link #getClusterModes()} instead. - */ - @Deprecated - public VehicleDataResult getClusterModeStatus() { - return getClusterModes(); - } - - /** - * Sets the status modes of the cluster - * - * @param clusterMode the status modes of the cluster - */ - public UnsubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) { - setParameters(KEY_CLUSTER_MODES, clusterMode); - return this; - } - - /** - * Gets the status modes of the cluster - * - * @return The status modes of the cluster - */ - public VehicleDataResult getClusterModes() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES); - } - - public UnsubscribeVehicleDataResponse setMyKey(VehicleDataResult myKey) { - setParameters(KEY_MY_KEY, myKey); - return this; - } - - public VehicleDataResult getMyKey() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_MY_KEY); - } - - /** - * Sets the fuelRange. - * - * @param fuelRange The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the - * vehicle. See struct FuelRange for details. - * @since SmartDeviceLink 5.0.0 - */ - public UnsubscribeVehicleDataResponse setFuelRange(VehicleDataResult fuelRange) { - setParameters(KEY_FUEL_RANGE, fuelRange); - return this; - } - - /** - * Gets the fuelRange. - * - * @return VehicleDataResult The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the - * vehicle. See struct FuelRange for details. - * @since SmartDeviceLink 5.0.0 - */ - public VehicleDataResult getFuelRange() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_RANGE); - } - - /** - * Sets turnSignal - * - * @param turnSignal a VehicleDataResult related to the turn signal status - */ - public UnsubscribeVehicleDataResponse setTurnSignal(VehicleDataResult turnSignal) { - setParameters(KEY_TURN_SIGNAL, turnSignal); - return this; - } - - /** - * Gets turnSignal - * - * @return a VehicleDataResult related to the turn signal status - */ - public VehicleDataResult getTurnSignal() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_TURN_SIGNAL); - } - - /** - * Sets electronicParkBrakeStatus - * - * @param electronicParkBrakeStatus a VehicleDataResult related to the electronic park brake status - */ - public UnsubscribeVehicleDataResponse setElectronicParkBrakeStatus(VehicleDataResult electronicParkBrakeStatus) { - setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus); - return this; - } - - /** - * Gets electronicParkBrakeStatus - * - * @return a VehicleDataResult related to the electronic park brake status - */ - public VehicleDataResult getElectronicParkBrakeStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ELECTRONIC_PARK_BRAKE_STATUS); - } - - /** - * Sets cloudAppVehicleID - * - * @param cloudAppVehicleID a VehicleDataResult related to the cloud app vehicle ID - */ - public UnsubscribeVehicleDataResponse setCloudAppVehicleID(VehicleDataResult cloudAppVehicleID) { - setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID); - return this; - } - - /** - * Gets a VehicleDataResult for the unsubscribe response of the CloudAppVehicleID vehicle data item. - * - * @return a VehicleDataResult related to the cloud app vehicle ID - */ - public VehicleDataResult getCloudAppVehicleID() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLOUD_APP_VEHICLE_ID); - } - - /** - * Sets a value for OEM Custom VehicleData. - * - * @param vehicleDataName a String value - * @param vehicleDataState a VehicleDataResult value - */ - public UnsubscribeVehicleDataResponse setOEMCustomVehicleData(String vehicleDataName, VehicleDataResult vehicleDataState) { - setParameters(vehicleDataName, vehicleDataState); - return this; - } - - /** - * Gets a VehicleDataResult for the vehicle data item. - * - * @return a VehicleDataResult related to the vehicle data - */ - public VehicleDataResult getOEMCustomVehicleData(String vehicleDataName) { - return (VehicleDataResult) getObject(VehicleDataResult.class, vehicleDataName); - } - - /** - * Sets the handsOffSteering. - * - * @param handsOffSteering To indicate whether driver hands are off the steering wheel - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleDataResponse setHandsOffSteering(VehicleDataResult handsOffSteering) { - setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering); - return this; - } - - /** - * Gets the handsOffSteering. - * - * @return VehicleDataResult To indicate whether driver hands are off the steering wheel - * @since SmartDeviceLink 7.0.0 - */ - public VehicleDataResult getHandsOffSteering() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_HANDS_OFF_STEERING); - } - - /** - * Sets the windowStatus. - * - * @param windowStatus See WindowStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleDataResponse setWindowStatus(VehicleDataResult windowStatus) { - setParameters(KEY_WINDOW_STATUS, windowStatus); - return this; - } - - /** - * Gets the windowStatus. - * - * @return VehicleDataResult See WindowStatus - * @since SmartDeviceLink 7.0.0 - */ - public VehicleDataResult getWindowStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_WINDOW_STATUS); - } - - /** - * Sets the gearStatus. - * - * @param gearStatus See GearStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleDataResponse setGearStatus(VehicleDataResult gearStatus) { - setParameters(KEY_GEAR_STATUS, gearStatus); - return this; - } - - /** - * Gets the gearStatus. - * - * @return VehicleDataResult See GearStatus - * @since SmartDeviceLink 7.0.0 - */ - public VehicleDataResult getGearStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_GEAR_STATUS); - } - - /** - * Gets the stabilityControlsStatus. - * - * @return VehicleDataResult See StabilityControlsStatus - * @since SmartDeviceLink 7.0.0 - */ - public VehicleDataResult getStabilityControlsStatus() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STABILITY_CONTROLS_STATUS); - } - - /** - * Sets the stabilityControlsStatus. - * - * @param stabilityControlsStatus See StabilityControlsStatus - * @since SmartDeviceLink 7.0.0 - */ - public UnsubscribeVehicleDataResponse setStabilityControlsStatus(VehicleDataResult stabilityControlsStatus) { - setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus); - return this; - } - - /** - * Sets the seatOccupancy. - * - * @param seatOccupancy See SeatOccupancy - * @since SmartDeviceLink 7.1.0 - */ - public UnsubscribeVehicleDataResponse setSeatOccupancy(VehicleDataResult seatOccupancy) { - setParameters(KEY_SEAT_OCCUPANCY, seatOccupancy); - return this; - } - - /** - * Gets the seatOccupancy. - * - * @return VehicleDataResult See SeatOccupancy - * @since SmartDeviceLink 7.1.0 - */ - public VehicleDataResult getSeatOccupancy() { - return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_SEAT_OCCUPANCY); - } -} +/*
+ * 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.protocol.enums.FunctionID;
+import com.smartdevicelink.proxy.RPCResponse;
+import com.smartdevicelink.proxy.rpc.enums.Result;
+
+import java.util.Hashtable;
+
+/**
+ * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called.
+ *
+ * @since SmartDeviceLink 2.0
+ */
+public class UnsubscribeVehicleDataResponse extends RPCResponse {
+ public static final String KEY_SPEED = "speed";
+ public static final String KEY_RPM = "rpm";
+ public static final String KEY_EXTERNAL_TEMPERATURE = "externalTemperature";
+ public static final String KEY_PRNDL = "prndl";
+ public static final String KEY_TIRE_PRESSURE = "tirePressure";
+ public static final String KEY_ENGINE_TORQUE = "engineTorque";
+ public static final String KEY_ENGINE_OIL_LIFE = "engineOilLife";
+ public static final String KEY_ODOMETER = "odometer";
+ public static final String KEY_GPS = "gps";
+ public static final String KEY_INSTANT_FUEL_CONSUMPTION = "instantFuelConsumption";
+ public static final String KEY_BELT_STATUS = "beltStatus";
+ public static final String KEY_BODY_INFORMATION = "bodyInformation";
+ public static final String KEY_DEVICE_STATUS = "deviceStatus";
+ public static final String KEY_DRIVER_BRAKING = "driverBraking";
+ public static final String KEY_WIPER_STATUS = "wiperStatus";
+ public static final String KEY_HEAD_LAMP_STATUS = "headLampStatus";
+ public static final String KEY_ACC_PEDAL_POSITION = "accPedalPosition";
+ public static final String KEY_STEERING_WHEEL_ANGLE = "steeringWheelAngle";
+ public static final String KEY_E_CALL_INFO = "eCallInfo";
+ public static final String KEY_AIRBAG_STATUS = "airbagStatus";
+ public static final String KEY_EMERGENCY_EVENT = "emergencyEvent";
+ @Deprecated
+ public static final String KEY_CLUSTER_MODE_STATUS = "clusterModeStatus";
+ public static final String KEY_CLUSTER_MODES = "clusterModes";
+ public static final String KEY_MY_KEY = "myKey";
+ public static final String KEY_FUEL_RANGE = "fuelRange";
+ public static final String KEY_TURN_SIGNAL = "turnSignal";
+ public static final String KEY_ELECTRONIC_PARK_BRAKE_STATUS = "electronicParkBrakeStatus";
+ public static final String KEY_CLOUD_APP_VEHICLE_ID = "cloudAppVehicleID";
+ public static final String KEY_HANDS_OFF_STEERING = "handsOffSteering";
+ public static final String KEY_WINDOW_STATUS = "windowStatus";
+ public static final String KEY_GEAR_STATUS = "gearStatus";
+ /**
+ * @deprecated
+ */
+ @Deprecated
+ public static final String KEY_FUEL_LEVEL = "fuelLevel";
+ /**
+ * @deprecated
+ */
+ @Deprecated
+ public static final String KEY_FUEL_LEVEL_STATE = "fuelLevel_State";
+ public static final String KEY_STABILITY_CONTROLS_STATUS = "stabilityControlsStatus";
+ /**
+ * @since SmartDeviceLink 7.1.0
+ */
+ public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy";
+ /**
+ * Constructs a new UnsubscribeVehicleDataResponse object
+ */
+ public UnsubscribeVehicleDataResponse() {
+ super(FunctionID.UNSUBSCRIBE_VEHICLE_DATA.toString());
+ }
+
+ /**
+ * Constructs a new UnsubscribeVehicleDataResponse object
+ *
+ * @param success whether the request is successfully processed
+ * @param resultCode whether the request is successfully processed
+ */
+ public UnsubscribeVehicleDataResponse(@NonNull Boolean success, @NonNull Result resultCode) {
+ this();
+ setSuccess(success);
+ setResultCode(resultCode);
+ }
+
+ /**
+ * Constructs a new UnsubscribeVehicleDataResponse object indicated by the Hashtable
+ * parameter
+ * <p></p>
+ *
+ * @param hash The Hashtable to use to build this RPC
+ */
+ public UnsubscribeVehicleDataResponse(Hashtable<String, Object> hash) {
+ super(hash);
+ }
+
+ /**
+ * Sets Gps
+ *
+ * @param gps a VehicleDataResult related to GPS
+ */
+ public UnsubscribeVehicleDataResponse setGps(VehicleDataResult gps) {
+ setParameters(KEY_GPS, gps);
+ return this;
+ }
+
+ /**
+ * Gets Gps
+ *
+ * @return a VehicleDataResult related to GPS
+ */
+ public VehicleDataResult getGps() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_GPS);
+ }
+
+ /**
+ * Sets Speed
+ *
+ * @param speed a VehicleDataResult related to speed
+ */
+ public UnsubscribeVehicleDataResponse setSpeed(VehicleDataResult speed) {
+ setParameters(KEY_SPEED, speed);
+ return this;
+ }
+
+ /**
+ * Gets Speed
+ *
+ * @return a VehicleDataResult related to speed
+ */
+ public VehicleDataResult getSpeed() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_SPEED);
+ }
+
+ /**
+ * Sets rpm
+ *
+ * @param rpm a VehicleDataResult related to RPM
+ */
+ public UnsubscribeVehicleDataResponse setRpm(VehicleDataResult rpm) {
+ setParameters(KEY_RPM, rpm);
+ return this;
+ }
+
+ /**
+ * Gets rpm
+ *
+ * @return a VehicleDataResult related to RPM
+ */
+ public VehicleDataResult getRpm() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_RPM);
+ }
+
+ /**
+ * Sets the fuelLevel.
+ *
+ * @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
+ * 7.0, please see fuelRange.
+ */
+ @Deprecated
+ public UnsubscribeVehicleDataResponse setFuelLevel(VehicleDataResult fuelLevel) {
+ setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
+ }
+
+ /**
+ * Gets the fuelLevel.
+ *
+ * @return VehicleDataResult The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
+ * 7.0, please see fuelRange.
+ */
+ @Deprecated
+ public VehicleDataResult getFuelLevel() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_LEVEL);
+ }
+
+ /**
+ * Sets Fuel Level State
+ *
+ * @param fuelLevelState a VehicleDataResult related to FuelLevel State
+ */
+ @Deprecated
+ public UnsubscribeVehicleDataResponse setFuelLevelState(VehicleDataResult fuelLevelState) {
+ setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
+ }
+
+ /**
+ * Gets Fuel Level State
+ *
+ * @return a VehicleDataResult related to FuelLevel State
+ */
+ @Deprecated
+ public VehicleDataResult getFuelLevelState() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_LEVEL_STATE);
+ }
+
+ /**
+ * Sets Instant Fuel Consumption
+ *
+ * @param instantFuelConsumption a VehicleDataResult related to instant fuel consumption
+ */
+ public UnsubscribeVehicleDataResponse setInstantFuelConsumption(VehicleDataResult instantFuelConsumption) {
+ setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
+ }
+
+ /**
+ * Gets Instant Fuel Consumption
+ *
+ * @return a VehicleDataResult related to instant fuel consumption
+ */
+ public VehicleDataResult getInstantFuelConsumption() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_INSTANT_FUEL_CONSUMPTION);
+ }
+
+ /**
+ * Sets External Temperature
+ *
+ * @param externalTemperature a VehicleDataResult related to external temperature
+ */
+ public UnsubscribeVehicleDataResponse setExternalTemperature(VehicleDataResult externalTemperature) {
+ setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
+ }
+
+ /**
+ * Gets External Temperature
+ *
+ * @return a VehicleDataResult related to external temperature
+ */
+ public VehicleDataResult getExternalTemperature() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EXTERNAL_TEMPERATURE);
+ }
+
+ /**
+ * Sets the prndl.
+ *
+ * @param prndl See PRNDL.
+ * @deprecated in SmartDeviceLink 7.0.0
+ */
+ @Deprecated
+ public UnsubscribeVehicleDataResponse setPrndl(VehicleDataResult prndl) {
+ setParameters(KEY_PRNDL, prndl);
+ return this;
+ }
+
+ /**
+ * Gets the prndl.
+ *
+ * @return VehicleDataResult.
+ * @deprecated in SmartDeviceLink 7.0.0
+ */
+ @Deprecated
+ public VehicleDataResult getPrndl() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_PRNDL);
+ }
+
+ /**
+ * Sets Tire Pressure
+ *
+ * @param tirePressure a VehicleDataResult related to tire pressure
+ */
+ public UnsubscribeVehicleDataResponse setTirePressure(VehicleDataResult tirePressure) {
+ setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
+ }
+
+ /**
+ * Gets Tire Pressure
+ *
+ * @return a VehicleDataResult related to tire pressure
+ */
+ public VehicleDataResult getTirePressure() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_TIRE_PRESSURE);
+ }
+
+ /**
+ * Sets Odometer
+ *
+ * @param odometer a VehicleDataResult related to the odometer
+ */
+ public UnsubscribeVehicleDataResponse setOdometer(VehicleDataResult odometer) {
+ setParameters(KEY_ODOMETER, odometer);
+ return this;
+ }
+
+ /**
+ * Gets Odometer
+ *
+ * @return a VehicleDataResult related to the odometer
+ */
+ public VehicleDataResult getOdometer() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ODOMETER);
+ }
+
+ /**
+ * Sets Belt Status
+ *
+ * @param beltStatus a VehicleDataResult related to the seat belt status
+ */
+ public UnsubscribeVehicleDataResponse setBeltStatus(VehicleDataResult beltStatus) {
+ setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
+ }
+
+ /**
+ * Gets Belt Status
+ *
+ * @return a VehicleDataResult related to the seat belt status
+ */
+ public VehicleDataResult getBeltStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_BELT_STATUS);
+ }
+
+ /**
+ * Sets Body Information
+ *
+ * @param bodyInformation a VehicleDataResult related to the body info
+ */
+ public UnsubscribeVehicleDataResponse setBodyInformation(VehicleDataResult bodyInformation) {
+ setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
+ }
+
+ /**
+ * Gets Body Information
+ *
+ * @return a VehicleDataResult related to the body info
+ */
+ public VehicleDataResult getBodyInformation() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_BODY_INFORMATION);
+ }
+
+ /**
+ * Sets Device Status
+ *
+ * @param deviceStatus a VehicleDataResult related to the device status of the connected device
+ */
+ public UnsubscribeVehicleDataResponse setDeviceStatus(VehicleDataResult deviceStatus) {
+ setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
+ }
+
+ /**
+ * Gets Device Status
+ *
+ * @return a VehicleDataResult related to the device status of the connected device
+ */
+ public VehicleDataResult getDeviceStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_DEVICE_STATUS);
+ }
+
+ /**
+ * Sets Driver Braking
+ *
+ * @param driverBraking a VehicleDataResult related to the driver breaking status
+ */
+ public UnsubscribeVehicleDataResponse setDriverBraking(VehicleDataResult driverBraking) {
+ setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
+ }
+
+ /**
+ * Gets Driver Braking
+ *
+ * @return a VehicleDataResult related to the driver breaking status
+ */
+ public VehicleDataResult getDriverBraking() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_DRIVER_BRAKING);
+ }
+
+ /**
+ * Sets Wiper Status
+ *
+ * @param wiperStatus a VehicleDataResult related to the wiper status
+ */
+ public UnsubscribeVehicleDataResponse setWiperStatus(VehicleDataResult wiperStatus) {
+ setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
+ }
+
+ /**
+ * Gets Wiper Status
+ *
+ * @return a VehicleDataResult related to the wiper status
+ */
+ public VehicleDataResult getWiperStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_WIPER_STATUS);
+ }
+
+ /**
+ * Sets Head Lamp Status
+ *
+ * @param headLampStatus a VehicleDataResult related to the headlamp status
+ */
+ public UnsubscribeVehicleDataResponse setHeadLampStatus(VehicleDataResult headLampStatus) {
+ setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
+ }
+
+ /**
+ * Gets Head Lamp Status
+ *
+ * @return a VehicleDataResult related to the headlamp status
+ */
+ public VehicleDataResult getHeadLampStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_HEAD_LAMP_STATUS);
+ }
+
+ /**
+ * Sets Engine Torque
+ *
+ * @param engineTorque a VehicleDataResult related to the engine's torque
+ */
+ public UnsubscribeVehicleDataResponse setEngineTorque(VehicleDataResult engineTorque) {
+ setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
+ }
+
+ /**
+ * Gets Engine Torque
+ *
+ * @return a VehicleDataResult related to the engine's torque
+ */
+ public VehicleDataResult getEngineTorque() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ENGINE_TORQUE);
+ }
+
+ /**
+ * Sets Engine Oil Life
+ *
+ * @param engineOilLife a VehicleDataResult related to the engine's oil life
+ */
+ public UnsubscribeVehicleDataResponse setEngineOilLife(VehicleDataResult engineOilLife) {
+ setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
+ }
+
+ /**
+ * Gets Engine Oil Life
+ *
+ * @return a VehicleDataResult related to the engine's oil life
+ */
+ public VehicleDataResult getEngineOilLife() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ENGINE_OIL_LIFE);
+ }
+
+ /**
+ * Sets AccPedal Position
+ *
+ * @param accPedalPosition a VehicleDataResult related to the accelerator pedal's position
+ */
+ public UnsubscribeVehicleDataResponse setAccPedalPosition(VehicleDataResult accPedalPosition) {
+ setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
+ }
+
+ /**
+ * Gets AccPedal Position
+ *
+ * @return a VehicleDataResult related to the accelerator pedal's position
+ */
+ public VehicleDataResult getAccPedalPosition() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ACC_PEDAL_POSITION);
+ }
+
+ public UnsubscribeVehicleDataResponse setSteeringWheelAngle(VehicleDataResult steeringWheelAngle) {
+ setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
+ }
+
+ public VehicleDataResult getSteeringWheelAngle() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STEERING_WHEEL_ANGLE);
+ }
+
+ public UnsubscribeVehicleDataResponse setECallInfo(VehicleDataResult eCallInfo) {
+ setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
+ }
+
+ public VehicleDataResult getECallInfo() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_E_CALL_INFO);
+ }
+
+ public UnsubscribeVehicleDataResponse setAirbagStatus(VehicleDataResult airbagStatus) {
+ setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
+ }
+
+ public VehicleDataResult getAirbagStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_AIRBAG_STATUS);
+ }
+
+ public UnsubscribeVehicleDataResponse setEmergencyEvent(VehicleDataResult emergencyEvent) {
+ setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
+ }
+
+ public VehicleDataResult getEmergencyEvent() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);
+ }
+
+ /**
+ * @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead.
+ */
+ @Deprecated
+ public UnsubscribeVehicleDataResponse setClusterModeStatus(VehicleDataResult clusterModeStatus) {
+ return setClusterModes(clusterModeStatus);
+ }
+
+ /**
+ * @deprecated use {@link #getClusterModes()} instead.
+ */
+ @Deprecated
+ public VehicleDataResult getClusterModeStatus() {
+ return getClusterModes();
+ }
+
+ /**
+ * Sets the status modes of the cluster
+ *
+ * @param clusterMode the status modes of the cluster
+ */
+ public UnsubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) {
+ setParameters(KEY_CLUSTER_MODES, clusterMode);
+ return this;
+ }
+
+ /**
+ * Gets the status modes of the cluster
+ *
+ * @return The status modes of the cluster
+ */
+ public VehicleDataResult getClusterModes() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES);
+ }
+
+ public UnsubscribeVehicleDataResponse setMyKey(VehicleDataResult myKey) {
+ setParameters(KEY_MY_KEY, myKey);
+ return this;
+ }
+
+ public VehicleDataResult getMyKey() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_MY_KEY);
+ }
+
+ /**
+ * Sets the fuelRange.
+ *
+ * @param fuelRange The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the
+ * vehicle. See struct FuelRange for details.
+ * @since SmartDeviceLink 5.0.0
+ */
+ public UnsubscribeVehicleDataResponse setFuelRange(VehicleDataResult fuelRange) {
+ setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
+ }
+
+ /**
+ * Gets the fuelRange.
+ *
+ * @return VehicleDataResult The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the
+ * vehicle. See struct FuelRange for details.
+ * @since SmartDeviceLink 5.0.0
+ */
+ public VehicleDataResult getFuelRange() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_FUEL_RANGE);
+ }
+
+ /**
+ * Sets turnSignal
+ *
+ * @param turnSignal a VehicleDataResult related to the turn signal status
+ */
+ public UnsubscribeVehicleDataResponse setTurnSignal(VehicleDataResult turnSignal) {
+ setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
+ }
+
+ /**
+ * Gets turnSignal
+ *
+ * @return a VehicleDataResult related to the turn signal status
+ */
+ public VehicleDataResult getTurnSignal() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_TURN_SIGNAL);
+ }
+
+ /**
+ * Sets electronicParkBrakeStatus
+ *
+ * @param electronicParkBrakeStatus a VehicleDataResult related to the electronic park brake status
+ */
+ public UnsubscribeVehicleDataResponse setElectronicParkBrakeStatus(VehicleDataResult electronicParkBrakeStatus) {
+ setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
+ }
+
+ /**
+ * Gets electronicParkBrakeStatus
+ *
+ * @return a VehicleDataResult related to the electronic park brake status
+ */
+ public VehicleDataResult getElectronicParkBrakeStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ELECTRONIC_PARK_BRAKE_STATUS);
+ }
+
+ /**
+ * Sets cloudAppVehicleID
+ *
+ * @param cloudAppVehicleID a VehicleDataResult related to the cloud app vehicle ID
+ */
+ public UnsubscribeVehicleDataResponse setCloudAppVehicleID(VehicleDataResult cloudAppVehicleID) {
+ setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
+ }
+
+ /**
+ * Gets a VehicleDataResult for the unsubscribe response of the CloudAppVehicleID vehicle data item.
+ *
+ * @return a VehicleDataResult related to the cloud app vehicle ID
+ */
+ public VehicleDataResult getCloudAppVehicleID() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLOUD_APP_VEHICLE_ID);
+ }
+
+ /**
+ * Sets a value for OEM Custom VehicleData.
+ *
+ * @param vehicleDataName a String value
+ * @param vehicleDataState a VehicleDataResult value
+ */
+ public UnsubscribeVehicleDataResponse setOEMCustomVehicleData(String vehicleDataName, VehicleDataResult vehicleDataState) {
+ setParameters(vehicleDataName, vehicleDataState);
+ return this;
+ }
+
+ /**
+ * Gets a VehicleDataResult for the vehicle data item.
+ *
+ * @return a VehicleDataResult related to the vehicle data
+ */
+ public VehicleDataResult getOEMCustomVehicleData(String vehicleDataName) {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, vehicleDataName);
+ }
+
+ /**
+ * Sets the handsOffSteering.
+ *
+ * @param handsOffSteering To indicate whether driver hands are off the steering wheel
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleDataResponse setHandsOffSteering(VehicleDataResult handsOffSteering) {
+ setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
+ }
+
+ /**
+ * Gets the handsOffSteering.
+ *
+ * @return VehicleDataResult To indicate whether driver hands are off the steering wheel
+ * @since SmartDeviceLink 7.0.0
+ */
+ public VehicleDataResult getHandsOffSteering() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_HANDS_OFF_STEERING);
+ }
+
+ /**
+ * Sets the windowStatus.
+ *
+ * @param windowStatus See WindowStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleDataResponse setWindowStatus(VehicleDataResult windowStatus) {
+ setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
+ }
+
+ /**
+ * Gets the windowStatus.
+ *
+ * @return VehicleDataResult See WindowStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public VehicleDataResult getWindowStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_WINDOW_STATUS);
+ }
+
+ /**
+ * Sets the gearStatus.
+ *
+ * @param gearStatus See GearStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleDataResponse setGearStatus(VehicleDataResult gearStatus) {
+ setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
+ }
+
+ /**
+ * Gets the gearStatus.
+ *
+ * @return VehicleDataResult See GearStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public VehicleDataResult getGearStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_GEAR_STATUS);
+ }
+
+ /**
+ * Gets the stabilityControlsStatus.
+ *
+ * @return VehicleDataResult See StabilityControlsStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public VehicleDataResult getStabilityControlsStatus() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STABILITY_CONTROLS_STATUS);
+ }
+
+ /**
+ * Sets the stabilityControlsStatus.
+ *
+ * @param stabilityControlsStatus See StabilityControlsStatus
+ * @since SmartDeviceLink 7.0.0
+ */
+ public UnsubscribeVehicleDataResponse setStabilityControlsStatus(VehicleDataResult stabilityControlsStatus) {
+ setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
+ }
+
+ /**
+ * Sets the seatOccupancy.
+ *
+ * @param seatOccupancy See SeatOccupancy
+ * @since SmartDeviceLink 7.1.0
+ */
+ public UnsubscribeVehicleDataResponse setSeatOccupancy(VehicleDataResult seatOccupancy) {
+ setParameters(KEY_SEAT_OCCUPANCY, seatOccupancy);
+ return this;
+ }
+
+ /**
+ * Gets the seatOccupancy.
+ *
+ * @return VehicleDataResult See SeatOccupancy
+ * @since SmartDeviceLink 7.1.0
+ */
+ public VehicleDataResult getSeatOccupancy() {
+ return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_SEAT_OCCUPANCY);
+ }
+}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java index e4b8f00ed..579607ebf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataResultCode.java @@ -1,98 +1,98 @@ -/* - * 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.enums; - -/** - * Enumeration that describes possible result codes of a vehicle data entry request. - * - * @see com.smartdevicelink.proxy.rpc.DIDResult - * @see com.smartdevicelink.proxy.rpc.ReadDID - * @since SmartDeviceLink 2.0 - */ - -public enum VehicleDataResultCode { - /** - * Individual vehicle data item / DTC / DID request or subscription successful - */ - - SUCCESS, - /** - * DTC / DID request successful, however, not all active DTCs or full contents of DID location available - * - * @since SmartDeviceLink 4.0 - */ - - TRUNCATED_DATA, - /** - * This vehicle data item is not allowed for this app .The request is not authorized in local policies. - */ - - DISALLOWED, - /** - * The user has not granted access to this type of vehicle data item at this time. - */ - - USER_DISALLOWED, - /** - * The ECU ID referenced is not a valid ID on the bus / system. - */ - - INVALID_ID, - /** - * The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system. - */ - - VEHICLE_DATA_NOT_AVAILABLE, - /** - * The vehicle data item is already subscribed. - */ - - DATA_ALREADY_SUBSCRIBED, - /** - * The vehicle data item cannot be unsubscribed because it is not currently subscribed. - */ - - DATA_NOT_SUBSCRIBED, - /** - * The request for this item is ignored because it is already in progress - */ - - IGNORED; - - public static VehicleDataResultCode valueForString(String value) { - try { - return valueOf(value); - } catch (Exception e) { - return null; - } - } -} +/*
+ * 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.enums;
+
+/**
+ * Enumeration that describes possible result codes of a vehicle data entry request.
+ *
+ * @see com.smartdevicelink.proxy.rpc.DIDResult
+ * @see com.smartdevicelink.proxy.rpc.ReadDID
+ * @since SmartDeviceLink 2.0
+ */
+
+public enum VehicleDataResultCode {
+ /**
+ * Individual vehicle data item / DTC / DID request or subscription successful
+ */
+
+ SUCCESS,
+ /**
+ * DTC / DID request successful, however, not all active DTCs or full contents of DID location available
+ *
+ * @since SmartDeviceLink 4.0
+ */
+
+ TRUNCATED_DATA,
+ /**
+ * This vehicle data item is not allowed for this app .The request is not authorized in local policies.
+ */
+
+ DISALLOWED,
+ /**
+ * The user has not granted access to this type of vehicle data item at this time.
+ */
+
+ USER_DISALLOWED,
+ /**
+ * The ECU ID referenced is not a valid ID on the bus / system.
+ */
+
+ INVALID_ID,
+ /**
+ * The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.
+ */
+
+ VEHICLE_DATA_NOT_AVAILABLE,
+ /**
+ * The vehicle data item is already subscribed.
+ */
+
+ DATA_ALREADY_SUBSCRIBED,
+ /**
+ * The vehicle data item cannot be unsubscribed because it is not currently subscribed.
+ */
+
+ DATA_NOT_SUBSCRIBED,
+ /**
+ * The request for this item is ignored because it is already in progress
+ */
+
+ IGNORED;
+
+ public static VehicleDataResultCode valueForString(String value) {
+ try {
+ return valueOf(value);
+ } catch (Exception e) {
+ return null;
+ }
+ }
+}
|