1 package com.smartdevicelink.proxy.rpc;
\r
3 import java.util.Hashtable;
\r
4 import java.util.Vector;
\r
6 import com.smartdevicelink.proxy.RPCRequest;
\r
7 import com.smartdevicelink.proxy.constants.Names;
\r
8 import com.smartdevicelink.proxy.rpc.enums.VehicleDataType;
\r
9 import com.smartdevicelink.util.DebugTool;
\r
12 * Subscribes for specific published vehicle data items. The data will be only
\r
13 * sent, if it has changed. The application will be notified by the
\r
14 * onVehicleData notification whenever new data is available. The update rate is
\r
15 * very much dependent on sensors, vehicle architecture and vehicle type. Be
\r
16 * also prepared for the situation that a signal is not available on a vehicle
\r
18 * Function Group: Location, VehicleInfo and DrivingChara
\r
20 * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
\r
23 * @since SmartDeviceLink 2.0
\r
24 * @see UnsubscribeVehicleData
\r
25 * @see GetVehicleData
\r
27 public class SubscribeVehicleData extends RPCRequest {
\r
30 * Constructs a new SubscribeVehicleData object
\r
32 public SubscribeVehicleData() {
\r
33 super("SubscribeVehicleData");
\r
37 * Constructs a new SubscribeVehicleData object indicated by the Hashtable
\r
42 * The Hashtable to use
\r
44 public SubscribeVehicleData(Hashtable hash) {
\r
49 * Sets a boolean value. If true, subscribes Gps data
\r
54 public void setGps(Boolean gps) {
\r
56 parameters.put(Names.gps, gps);
\r
58 parameters.remove(Names.gps);
\r
63 * Gets a boolean value. If true, means the Gps data has been subscribed.
\r
65 * @return Boolean -a Boolean value. If true, means the Gps data has been
\r
68 public Boolean getGps() {
\r
69 return (Boolean) parameters.get(Names.gps);
\r
73 * Sets a boolean value. If true, subscribes speed data
\r
78 public void setSpeed(Boolean speed) {
\r
79 if (speed != null) {
\r
80 parameters.put(Names.speed, speed);
\r
82 parameters.remove(Names.speed);
\r
87 * Gets a boolean value. If true, means the Speed data has been subscribed.
\r
89 * @return Boolean -a Boolean value. If true, means the Speed data has been
\r
92 public Boolean getSpeed() {
\r
93 return (Boolean) parameters.get(Names.speed);
\r
97 * Sets a boolean value. If true, subscribes rpm data
\r
102 public void setRpm(Boolean rpm) {
\r
104 parameters.put(Names.rpm, rpm);
\r
106 parameters.remove(Names.rpm);
\r
111 * Gets a boolean value. If true, means the rpm data has been subscribed.
\r
113 * @return Boolean -a Boolean value. If true, means the rpm data has been
\r
116 public Boolean getRpm() {
\r
117 return (Boolean) parameters.get(Names.rpm);
\r
121 * Sets a boolean value. If true, subscribes FuelLevel data
\r
126 public void setFuelLevel(Boolean fuelLevel) {
\r
127 if (fuelLevel != null) {
\r
128 parameters.put(Names.fuelLevel, fuelLevel);
\r
130 parameters.remove(Names.fuelLevel);
\r
135 * Gets a boolean value. If true, means the FuelLevel data has been
\r
138 * @return Boolean -a Boolean value. If true, means the FuelLevel data has
\r
141 public Boolean getFuelLevel() {
\r
142 return (Boolean) parameters.get(Names.fuelLevel);
\r
146 * Sets a boolean value. If true, subscribes fuelLevel_State data
\r
148 * @param fuelLevel_State
\r
151 public void setFuelLevel_State(Boolean fuelLevel_State) {
\r
152 if (fuelLevel_State != null) {
\r
153 parameters.put(Names.fuelLevel_State, fuelLevel_State);
\r
155 parameters.remove(Names.fuelLevel_State);
\r
160 * Gets a boolean value. If true, means the fuelLevel_State data has been
\r
163 * @return Boolean -a Boolean value. If true, means the fuelLevel_State data
\r
164 * has been subscribed.
\r
166 public Boolean getFuelLevel_State() {
\r
167 return (Boolean) parameters.get(Names.fuelLevel_State);
\r
171 * Sets a boolean value. If true, subscribes instantFuelConsumption data
\r
173 * @param instantFuelConsumption
\r
176 public void setInstantFuelConsumption(Boolean instantFuelConsumption) {
\r
177 if (instantFuelConsumption != null) {
\r
178 parameters.put(Names.instantFuelConsumption, instantFuelConsumption);
\r
180 parameters.remove(Names.instantFuelConsumption);
\r
185 * Gets a boolean value. If true, means the getInstantFuelConsumption data has been
\r
188 * @return Boolean -a Boolean value. If true, means the getInstantFuelConsumption data
\r
189 * has been subscribed.
\r
191 public Boolean getInstantFuelConsumption() {
\r
192 return (Boolean) parameters.get(Names.instantFuelConsumption);
\r
196 * Sets a boolean value. If true, subscribes externalTemperature data
\r
198 * @param externalTemperature
\r
201 public void setExternalTemperature(Boolean externalTemperature) {
\r
202 if (externalTemperature != null) {
\r
203 parameters.put(Names.externalTemperature, externalTemperature);
\r
205 parameters.remove(Names.externalTemperature);
\r
210 * Gets a boolean value. If true, means the externalTemperature data has been
\r
213 * @return Boolean -a Boolean value. If true, means the externalTemperature data
\r
214 * has been subscribed.
\r
216 public Boolean getExternalTemperature() {
\r
217 return (Boolean) parameters.get(Names.externalTemperature);
\r
221 * Sets a boolean value. If true, subscribes Currently selected gear data
\r
226 public void setPrndl(Boolean prndl) {
\r
227 if (prndl != null) {
\r
228 parameters.put(Names.prndl, prndl);
\r
230 parameters.remove(Names.prndl);
\r
235 * Gets a boolean value. If true, means the Currently selected gear data has been
\r
238 * @return Boolean -a Boolean value. If true, means the Currently selected gear data
\r
239 * has been subscribed.
\r
241 public Boolean getPrndl() {
\r
242 return (Boolean) parameters.get(Names.prndl);
\r
246 * Sets a boolean value. If true, subscribes tire pressure status data
\r
248 * @param tirePressure
\r
251 public void setTirePressure(Boolean tirePressure) {
\r
252 if (tirePressure != null) {
\r
253 parameters.put(Names.tirePressure, tirePressure);
\r
255 parameters.remove(Names.tirePressure);
\r
260 * Gets a boolean value. If true, means the tire pressure status data has been
\r
263 * @return Boolean -a Boolean value. If true, means the tire pressure status data
\r
264 * has been subscribed.
\r
266 public Boolean getTirePressure() {
\r
267 return (Boolean) parameters.get(Names.tirePressure);
\r
271 * Sets a boolean value. If true, subscribes odometer data
\r
276 public void setOdometer(Boolean odometer) {
\r
277 if (odometer != null) {
\r
278 parameters.put(Names.odometer, odometer);
\r
280 parameters.remove(Names.odometer);
\r
285 * Gets a boolean value. If true, means the odometer data has been
\r
288 * @return Boolean -a Boolean value. If true, means the odometer data
\r
289 * has been subscribed.
\r
291 public Boolean getOdometer() {
\r
292 return (Boolean) parameters.get(Names.odometer);
\r
296 * Sets a boolean value. If true, subscribes belt Status data
\r
298 * @param beltStatus
\r
301 public void setBeltStatus(Boolean beltStatus) {
\r
302 if (beltStatus != null) {
\r
303 parameters.put(Names.beltStatus, beltStatus);
\r
305 parameters.remove(Names.beltStatus);
\r
310 * Gets a boolean value. If true, means the belt Status data has been
\r
313 * @return Boolean -a Boolean value. If true, means the belt Status data
\r
314 * has been subscribed.
\r
316 public Boolean getBeltStatus() {
\r
317 return (Boolean) parameters.get(Names.beltStatus);
\r
321 * Sets a boolean value. If true, subscribes body Information data
\r
323 * @param bodyInformation
\r
326 public void setBodyInformation(Boolean bodyInformation) {
\r
327 if (bodyInformation != null) {
\r
328 parameters.put(Names.bodyInformation, bodyInformation);
\r
330 parameters.remove(Names.bodyInformation);
\r
335 * Gets a boolean value. If true, means the body Information data has been
\r
338 * @return Boolean -a Boolean value. If true, means the body Information data
\r
339 * has been subscribed.
\r
341 public Boolean getBodyInformation() {
\r
342 return (Boolean) parameters.get(Names.bodyInformation);
\r
346 * Sets a boolean value. If true, subscribes device Status data
\r
348 * @param deviceStatus
\r
351 public void setDeviceStatus(Boolean deviceStatus) {
\r
352 if (deviceStatus != null) {
\r
353 parameters.put(Names.deviceStatus, deviceStatus);
\r
355 parameters.remove(Names.deviceStatus);
\r
360 * Gets a boolean value. If true, means the device Status data has been
\r
363 * @return Boolean -a Boolean value. If true, means the device Status data
\r
364 * has been subscribed.
\r
366 public Boolean getDeviceStatus() {
\r
367 return (Boolean) parameters.get(Names.deviceStatus);
\r
371 * Sets a boolean value. If true, subscribes driver Braking data
\r
373 * @param driverBraking
\r
376 public void setDriverBraking(Boolean driverBraking) {
\r
377 if (driverBraking != null) {
\r
378 parameters.put(Names.driverBraking, driverBraking);
\r
380 parameters.remove(Names.driverBraking);
\r
385 * Gets a boolean value. If true, means the driver Braking data has been
\r
388 * @return Boolean -a Boolean value. If true, means the driver Braking data
\r
389 * has been subscribed.
\r
391 public Boolean getDriverBraking() {
\r
392 return (Boolean) parameters.get(Names.driverBraking);
\r
396 * Sets a boolean value. If true, subscribes wiper Status data
\r
398 * @param wiperStatus
\r
401 public void setWiperStatus(Boolean wiperStatus) {
\r
402 if (wiperStatus != null) {
\r
403 parameters.put(Names.wiperStatus, wiperStatus);
\r
405 parameters.remove(Names.wiperStatus);
\r
410 * Gets a boolean value. If true, means the wiper Status data has been
\r
413 * @return Boolean -a Boolean value. If true, means the wiper Status data
\r
414 * has been subscribed.
\r
416 public Boolean getWiperStatus() {
\r
417 return (Boolean) parameters.get(Names.wiperStatus);
\r
421 * Sets a boolean value. If true, subscribes fuel Economy data
\r
423 * @param fuelEconomy
\r
426 public void setFuelEconomy(Boolean fuelEconomy) {
\r
427 if (fuelEconomy != null) {
\r
428 parameters.put(Names.fuelEconomy, fuelEconomy);
\r
430 parameters.remove(Names.fuelEconomy);
\r
435 * Gets a boolean value. If true, means the fuel Economy data has been
\r
438 * @return Boolean -a Boolean value. If true, means the fuel Economy data
\r
439 * has been subscribed.
\r
441 public Boolean getFuelEconomy() {
\r
442 return (Boolean) parameters.get(Names.fuelEconomy);
\r
446 * Sets a boolean value. If true, subscribes Engine Oil Life data
\r
448 * @param engineOilLife
\r
451 public void setEngineOilLife(Boolean engineOilLife) {
\r
452 if (engineOilLife != null) {
\r
453 parameters.put(Names.engineOilLife, engineOilLife);
\r
455 parameters.remove(Names.engineOilLife);
\r
460 * Gets a boolean value. If true, means the Engine Oil Life data has been
\r
463 * @return Boolean -a Boolean value. If true, means the Engine Oil Life data
\r
464 * has been subscribed.
\r
466 public Boolean getEngineOilLife() {
\r
467 return (Boolean) parameters.get(Names.engineOilLife);
\r
471 * Sets a boolean value. If true, subscribes Head Lamp Status data
\r
473 * @param headLampStatus
\r
476 public void setHeadLampStatus(Boolean headLampStatus) {
\r
477 if (headLampStatus != null) {
\r
478 parameters.put(Names.headLampStatus, headLampStatus);
\r
480 parameters.remove(Names.headLampStatus);
\r
485 * Gets a boolean value. If true, means the Head Lamp Status data has been
\r
488 * @return Boolean -a Boolean value. If true, means the Head Lamp Status data
\r
489 * has been subscribed.
\r
491 public Boolean getHeadLampStatus() {
\r
492 return (Boolean) parameters.get(Names.headLampStatus);
\r
496 * Sets a boolean value. If true, subscribes Battery Voltage data
\r
498 * @param batteryVoltage
\r
501 public void setBatteryVoltage(Boolean batteryVoltage) {
\r
502 if (batteryVoltage != null) {
\r
503 parameters.put(Names.batteryVoltage, batteryVoltage);
\r
505 parameters.remove(Names.batteryVoltage);
\r
510 * Gets a boolean value. If true, means the Battery Voltage data has been
\r
513 * @return Boolean -a Boolean value. If true, means the Battery Voltage data
\r
514 * has been subscribed.
\r
516 public Boolean getBatteryVoltage() {
\r
517 return (Boolean) parameters.get(Names.batteryVoltage);
\r
521 * Sets a boolean value. If true, subscribes Brake Torque data
\r
523 * @param brakeTorque
\r
526 public void setBrakeTorque(Boolean brakeTorque) {
\r
527 if (brakeTorque != null) {
\r
528 parameters.put(Names.brakeTorque, brakeTorque);
\r
530 parameters.remove(Names.brakeTorque);
\r
535 * Gets a boolean value. If true, means the Brake Torque data has been
\r
538 * @return Boolean -a Boolean value. If true, means the Brake Torque data
\r
539 * has been subscribed.
\r
541 public Boolean getBrakeTorque() {
\r
542 return (Boolean) parameters.get(Names.brakeTorque);
\r
546 * Sets a boolean value. If true, subscribes Engine Torque data
\r
548 * @param engineTorque
\r
551 public void setEngineTorque(Boolean engineTorque) {
\r
552 if (engineTorque != null) {
\r
553 parameters.put(Names.engineTorque, engineTorque);
\r
555 parameters.remove(Names.engineTorque);
\r
560 * Gets a boolean value. If true, means the Engine Torque data has been
\r
563 * @return Boolean -a Boolean value. If true, means the Engine Torque data
\r
564 * has been subscribed.
\r
566 public Boolean getEngineTorque() {
\r
567 return (Boolean) parameters.get(Names.engineTorque);
\r
571 * Sets a boolean value. If true, subscribes Turbo Boost data
\r
573 * @param turboBoost
\r
576 public void setTurboBoost(Boolean turboBoost) {
\r
577 if (turboBoost != null) {
\r
578 parameters.put(Names.turboBoost, turboBoost);
\r
580 parameters.remove(Names.turboBoost);
\r
585 * Gets a boolean value. If true, means the Turbo Boost data has been
\r
588 * @return Boolean -a Boolean value. If true, means the Turbo Boost data
\r
589 * has been subscribed.
\r
591 public Boolean getTurboBoost() {
\r
592 return (Boolean) parameters.get(Names.turboBoost);
\r
596 * Sets a boolean value. If true, subscribes Coolant Temp data
\r
598 * @param coolantTemp
\r
601 public void setCoolantTemp(Boolean coolantTemp) {
\r
602 if (coolantTemp != null) {
\r
603 parameters.put(Names.coolantTemp, coolantTemp);
\r
605 parameters.remove(Names.coolantTemp);
\r
610 * Gets a boolean value. If true, means the Coolant Temp data has been
\r
613 * @return Boolean -a Boolean value. If true, means the Coolant Temp data
\r
614 * has been subscribed.
\r
616 public Boolean getCoolantTemp() {
\r
617 return (Boolean) parameters.get(Names.coolantTemp);
\r
621 * Sets a boolean value. If true, subscribes Air Fuel Ratio data
\r
623 * @param airFuelRatio
\r
626 public void setAirFuelRatio(Boolean airFuelRatio) {
\r
627 if (airFuelRatio != null) {
\r
628 parameters.put(Names.airFuelRatio, airFuelRatio);
\r
630 parameters.remove(Names.airFuelRatio);
\r
635 * Gets a boolean value. If true, means the Air Fuel Ratio data has been
\r
638 * @return Boolean -a Boolean value. If true, means the Air Fuel Ratio data
\r
639 * has been subscribed.
\r
641 public Boolean getAirFuelRatio() {
\r
642 return (Boolean) parameters.get(Names.airFuelRatio);
\r
646 * Sets a boolean value. If true, subscribes Cooling Head Temp data
\r
648 * @param coolingHeadTemp
\r
651 public void setCoolingHeadTemp(Boolean coolingHeadTemp) {
\r
652 if (coolingHeadTemp != null) {
\r
653 parameters.put(Names.coolingHeadTemp, coolingHeadTemp);
\r
655 parameters.remove(Names.coolingHeadTemp);
\r
660 * Gets a boolean value. If true, means the Cooling Head Temp data has been
\r
663 * @return Boolean -a Boolean value. If true, means the Cooling Head Temp data
\r
664 * has been subscribed.
\r
666 public Boolean getCoolingHeadTemp() {
\r
667 return (Boolean) parameters.get(Names.coolingHeadTemp);
\r
671 * Sets a boolean value. If true, subscribes Cooling Oil Temp data
\r
676 public void setOilTemp(Boolean oilTemp) {
\r
677 if (oilTemp != null) {
\r
678 parameters.put(Names.oilTemp, oilTemp);
\r
680 parameters.remove(Names.oilTemp);
\r
685 * Gets a boolean value. If true, means the Oil Temp data has been
\r
688 * @return Boolean -a Boolean value. If true, means the Oil Temp data
\r
689 * has been subscribed.
\r
691 public Boolean getOilTemp() {
\r
692 return (Boolean) parameters.get(Names.oilTemp);
\r
696 * Sets a boolean value. If true, subscribes Intake Air Temp data
\r
698 * @param intakeAirTemp
\r
701 public void setIntakeAirTemp(Boolean intakeAirTemp) {
\r
702 if (intakeAirTemp != null) {
\r
703 parameters.put(Names.intakeAirTemp, intakeAirTemp);
\r
705 parameters.remove(Names.intakeAirTemp);
\r
710 * Gets a boolean value. If true, means the Intake Air Temp data has been
\r
713 * @return Boolean -a Boolean value. If true, means the Intake Air Temp data
\r
714 * has been subscribed.
\r
716 public Boolean getIntakeAirTemp() {
\r
717 return (Boolean) parameters.get(Names.intakeAirTemp);
\r
721 * Sets a boolean value. If true, subscribes Gear Shift Advice data
\r
723 * @param gearShiftAdvice
\r
726 public void setGearShiftAdvice(Boolean gearShiftAdvice) {
\r
727 if (gearShiftAdvice != null) {
\r
728 parameters.put(Names.gearShiftAdvice, gearShiftAdvice);
\r
730 parameters.remove(Names.gearShiftAdvice);
\r
735 * Gets a boolean value. If true, means the Gear Shift Advice data has been
\r
738 * @return Boolean -a Boolean value. If true, means the Gear Shift Advice data
\r
739 * has been subscribed.
\r
741 public Boolean getGearShiftAdvice() {
\r
742 return (Boolean) parameters.get(Names.gearShiftAdvice);
\r
746 * Sets a boolean value. If true, subscribes acceleration data
\r
748 * @param acceleration
\r
751 public void setAcceleration(Boolean acceleration) {
\r
752 if (acceleration != null) {
\r
753 parameters.put(Names.acceleration, acceleration);
\r
755 parameters.remove(Names.acceleration);
\r
760 * Gets a boolean value. If true, means the acceleration data has been
\r
763 * @return Boolean -a Boolean value. If true, means the acceleration data
\r
764 * has been subscribed.
\r
766 public Boolean getAcceleration() {
\r
767 return (Boolean) parameters.get(Names.acceleration);
\r
771 * Sets a boolean value. If true, subscribes accPedalPosition data
\r
773 * @param accPedalPosition
\r
776 public void setAccPedalPosition(Boolean accPedalPosition) {
\r
777 if (accPedalPosition != null) {
\r
778 parameters.put(Names.accPedalPosition, accPedalPosition);
\r
780 parameters.remove(Names.accPedalPosition);
\r
785 * Gets a boolean value. If true, means the accPedalPosition data has been
\r
788 * @return Boolean -a Boolean value. If true, means the accPedalPosition data
\r
789 * has been subscribed.
\r
791 public Boolean getAccPedalPosition() {
\r
792 return (Boolean) parameters.get(Names.accPedalPosition);
\r
796 * Sets a boolean value. If true, subscribes ClutchPedal Position data
\r
798 * @param clutchPedalPosition
\r
801 public void setClutchPedalPosition(Boolean clutchPedalPosition) {
\r
802 if (clutchPedalPosition != null) {
\r
803 parameters.put(Names.clutchPedalPosition, clutchPedalPosition);
\r
805 parameters.remove(Names.clutchPedalPosition);
\r
810 * Gets a boolean value. If true, means the ClutchPedal Position data has been
\r
813 * @return Boolean -a Boolean value. If true, means the ClutchPedal Position data
\r
814 * has been subscribed.
\r
816 public Boolean getClutchPedalPosition() {
\r
817 return (Boolean) parameters.get(Names.clutchPedalPosition);
\r
821 * Sets a boolean value. If true, subscribes Reverse Gear Status data
\r
823 * @param reverseGearStatus
\r
826 public void setReverseGearStatus(Boolean reverseGearStatus) {
\r
827 if (reverseGearStatus != null) {
\r
828 parameters.put(Names.reverseGearStatus, reverseGearStatus);
\r
830 parameters.remove(Names.reverseGearStatus);
\r
835 * Gets a boolean value. If true, means the Reverse Gear Status data has been
\r
838 * @return Boolean -a Boolean value. If true, means the Reverse Gear Status data
\r
839 * has been subscribed.
\r
841 public Boolean getReverseGearStatus() {
\r
842 return (Boolean) parameters.get(Names.reverseGearStatus);
\r
846 * Sets a boolean value. If true, subscribes accTorque data
\r
851 public void setAccTorque(Boolean accTorque) {
\r
852 if (accTorque != null) {
\r
853 parameters.put(Names.accTorque, accTorque);
\r
855 parameters.remove(Names.accTorque);
\r
860 * Gets a boolean value. If true, means the accTorque data has been
\r
863 * @return Boolean -a Boolean value. If true, means the accTorque data
\r
864 * has been subscribed.
\r
866 public Boolean getAccTorque() {
\r
867 return (Boolean) parameters.get(Names.accTorque);
\r
871 * Sets a boolean value. If true, subscribes evInfo data
\r
876 public void setEvInfo(Boolean evInfo) {
\r
877 if (evInfo != null) {
\r
878 parameters.put(Names.evInfo, evInfo);
\r
880 parameters.remove(Names.evInfo);
\r
885 * Gets a boolean value. If true, means the evInfo data has been
\r
888 * @return Boolean -a Boolean value. If true, means the evInfo data
\r
889 * has been subscribed.
\r
891 public Boolean getEvInfo() {
\r
892 return (Boolean) parameters.get(Names.evInfo);
\r
896 * Sets a boolean value. If true, subscribes Ambient Light Status data
\r
898 * @param ambientLightStatus
\r
901 public void setAmbientLightStatus(Boolean ambientLightStatus) {
\r
902 if (ambientLightStatus != null) {
\r
903 parameters.put(Names.ambientLightStatus, ambientLightStatus);
\r
905 parameters.remove(Names.ambientLightStatus);
\r
910 * Gets a boolean value. If true, means the Ambient Light Status data has been
\r
913 * @return Boolean -a Boolean value. If true, means the Ambient Light Status data
\r
914 * has been subscribed.
\r
916 public Boolean getAmbientLightStatus() {
\r
917 return (Boolean) parameters.get(Names.ambientLightStatus);
\r