com.smartdevicelink.proxy.rpc.TireStatus Maven / Gradle / Ivy
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus;
import com.smartdevicelink.proxy.rpc.enums.WarningLightStatus;
import com.smartdevicelink.util.DebugTool;
import java.util.Hashtable;
/**
* The status and pressure of the tires.
*
* Parameter List
*
*
*
* Param Name
* Type
* Description
* Required
* Notes
* Version Available
*
*
* pressureTelltale
* WarningLightStatus
* Status of the Tire Pressure Telltale. See WarningLightStatus.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
* leftFront
* SingleTireStatus
* The status of the left front tire.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
*
* rightFront
* SingleTireStatus
* The status of the right front tire.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
* leftRear
* SingleTireStatus
* The status of the left rear tire.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
* rightRear
* SingleTireStatus
* The status of the right rear tire.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
* innerLeftRear
* SingleTireStatus
* The status of the inner left rear.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
* innerRightRear
* SingleTireStatus
* The status of the inner right rear.
* N
*
* @since SmartDeviceLink 2.0.0
*
*
*
*
* @since SmartDeviceLink 2.0.0
*/
public class TireStatus extends RPCStruct {
private static final String TAG = "TireStatus";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_PRESSURE_TELL_TALE = "pressureTelltale";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_LEFT_FRONT = "leftFront";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_RIGHT_FRONT = "rightFront";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_LEFT_REAR = "leftRear";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_INNER_LEFT_REAR = "innerLeftRear";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_INNER_RIGHT_REAR = "innerRightRear";
/**
* @since SmartDeviceLink 2.0.0
*/
public static final String KEY_RIGHT_REAR = "rightRear";
public TireStatus() {
}
/**
* Constructs a new TireStatus object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public TireStatus(Hashtable hash) {
super(hash);
}
/**
* Constructs a new TireStatus object
*
* @param pressureTelltale Status of the Tire Pressure TellTale
* @param leftFront The status of the left front tire.
* @param rightFront The status of the right front tire.
* @param leftRear The status of the left rear tire.
* @param rightRear The status of the right rear tire
* @param innerLeftRear The status of the inner left rear tire.
* @param innerRightRear The status of the inner right rear tire.
*/
public TireStatus(WarningLightStatus pressureTelltale, SingleTireStatus leftFront, SingleTireStatus rightFront, SingleTireStatus leftRear, SingleTireStatus rightRear, SingleTireStatus innerLeftRear, SingleTireStatus innerRightRear) {
this();
setPressureTelltale(pressureTelltale);
setLeftFront(leftFront);
setRightFront(rightFront);
setLeftRear(leftRear);
setRightRear(rightRear);
setInnerLeftRear(innerLeftRear);
setInnerRightRear(innerRightRear);
}
/**
* @deprecated use {@link #setPressureTelltale(WarningLightStatus pressureTellTale)} instead.
*/
@Deprecated
public TireStatus setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {
return setPressureTelltale(pressureTellTale);
}
/**
* @deprecated use {@link #getPressureTelltale()} instead.
*/
@Deprecated
public WarningLightStatus getPressureTellTale() {
return getPressureTelltale();
}
/**
* Sets the status of the tire pressure Telltale.
*
* @param pressureTellTale the status of the tire pressure Telltale.
*/
public TireStatus setPressureTelltale(@NonNull WarningLightStatus pressureTellTale) {
setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
return this;
}
/**
* Gets the status of the tire pressure Telltale.
*
* @return the status of the tire pressure Telltale.
*/
public WarningLightStatus getPressureTelltale() {
WarningLightStatus warningLightStatus = (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);
if (warningLightStatus == null) {
WarningLightStatus newWarningLightStatus = WarningLightStatus.NOT_USED;
setValue(KEY_PRESSURE_TELL_TALE, newWarningLightStatus);
warningLightStatus = newWarningLightStatus;
DebugTool.logWarning(TAG, "TireStatus.pressureTelltale was null and will be set to .notUsed. In the future, this will change to be nullable.");
}
return warningLightStatus;
}
/**
* Sets the leftFront.
*
* @param leftFront The status of the left front tire.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setLeftFront(SingleTireStatus leftFront) {
setValue(KEY_LEFT_FRONT, leftFront);
return this;
}
/**
* Gets the leftFront.
*
* @return SingleTireStatus The status of the left front tire.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getLeftFront() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_FRONT);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_LEFT_FRONT, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.leftFront was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
/**
* Sets the rightFront.
*
* @param rightFront The status of the right front tire.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setRightFront(SingleTireStatus rightFront) {
setValue(KEY_RIGHT_FRONT, rightFront);
return this;
}
/**
* Gets the rightFront.
*
* @return SingleTireStatus The status of the right front tire.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getRightFront() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_FRONT);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_RIGHT_FRONT, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.rightFront was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
/**
* Sets the leftRear.
*
* @param leftRear The status of the left rear tire.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setLeftRear(SingleTireStatus leftRear) {
setValue(KEY_LEFT_REAR, leftRear);
return this;
}
/**
* Gets the leftRear.
*
* @return SingleTireStatus The status of the left rear tire.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getLeftRear() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_REAR);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_LEFT_REAR, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.leftRear was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
/**
* Sets the rightRear.
*
* @param rightRear The status of the right rear tire.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setRightRear(SingleTireStatus rightRear) {
setValue(KEY_RIGHT_REAR, rightRear);
return this;
}
/**
* Gets the rightRear.
*
* @return SingleTireStatus The status of the right rear tire.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getRightRear() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_REAR);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_RIGHT_REAR, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.rightRear was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
/**
* Sets the innerLeftRear.
*
* @param innerLeftRear The status of the inner left rear.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setInnerLeftRear(SingleTireStatus innerLeftRear) {
setValue(KEY_INNER_LEFT_REAR, innerLeftRear);
return this;
}
/**
* Gets the innerLeftRear.
*
* @return SingleTireStatus The status of the inner left rear.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getInnerLeftRear() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_INNER_LEFT_REAR);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_INNER_LEFT_REAR, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.innerLeftRear was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
/**
* Sets the innerRightRear.
*
* @param innerRightRear The status of the inner right rear.
* @since SmartDeviceLink 2.0.0
*/
public TireStatus setInnerRightRear(SingleTireStatus innerRightRear) {
setValue(KEY_INNER_RIGHT_REAR, innerRightRear);
return this;
}
/**
* Gets the innerRightRear.
*
* @return SingleTireStatus The status of the inner right rear.
* @since SmartDeviceLink 2.0.0
*/
public SingleTireStatus getInnerRightRear() {
SingleTireStatus tireStatus = (SingleTireStatus) getObject(SingleTireStatus.class, KEY_INNER_RIGHT_REAR);
if (tireStatus == null) {
SingleTireStatus newTireStatus = new SingleTireStatus().setStatus(ComponentVolumeStatus.UNKNOWN);
setValue(KEY_INNER_RIGHT_REAR, newTireStatus);
tireStatus = newTireStatus;
DebugTool.logWarning(TAG, "TireStatus.innerRightRear was null and will be set to .unknown. In the future, this will change to be nullable.");
}
return tireStatus;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy