com.smartdevicelink.proxy.rpc.BodyInformation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdl_java_se Show documentation

The app library component of SDL is meant to run on the end userâs smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.

There is a newer version: 5.7.0

Show newest version

/*
 * 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.IgnitionStableStatus;
import com.smartdevicelink.proxy.rpc.enums.IgnitionStatus;

import java.util.Hashtable;
import java.util.List;

/**
 * The body information including power modes.
 *
 * Note: The structure defines the information about the park brake and ignition.
 *
 * Parameter List
 * 
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 * 			
 * 			
 * 		
 *  Param Name Type Mandatory Description Version
ignitionStableStatus IgnitionStableStatus true Describes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus} SmartDeviceLink 2.0
ignitionStatus IgnitionStatus true The information about ignition status. See {@linkplain  IgnitionStatus} SmartDeviceLink 2.0
parkBrakeActive Boolean true The information about the park brake: - true, if active - false if not. SmartDeviceLink 2.0
driverDoorAjar Boolean false The information about the park brake: - true, if active - false if not. 
 * 				SmartDeviceLink 2.0.0
 * 			 

 * 			 

 * 				Deprecated in SmartDeviceLink 7.1.0
 * 			
passengerDoorAjar Boolean false The information about the park brake: - true, if active - false if not. 
 * 				SmartDeviceLink 2.0.0
 * 			 

 * 			 

 * 				Deprecated in SmartDeviceLink 7.1.0
 * 			
rearLeftDoorAjar Boolean false The information about the park brake: - true, if active - false if not. 
 * 				SmartDeviceLink 2.0.0
 * 			 

 * 			 

 * 				Deprecated in SmartDeviceLink 7.1.0
 * 			
rearRightDoorAjar Boolean false References signal "DrStatRr_B_Actl". 
 * 				SmartDeviceLink 2.0.0
 * 			 

 * 			 

 * 				Deprecated in SmartDeviceLink 7.1.0
 * 			
doorStatuses List False Provides status for doors if Ajar/Closed/Locked
 * 			{"array_min_size": 0, "array_max_size": 100} 
 * 				SmartDeviceLink 7.1.0
 * 			
gateStatuses List False Provides status for trunk/hood/etc. if Ajar/Closed/Locked
 * 			{"array_min_size": 0, "array_max_size": 100} 
 * 				SmartDeviceLink 7.1.0
 * 			
roofStatuses List False Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/			Removedetc.
 * 			{"array_min_size": 0, "array_max_size": 100} 
 * 				SmartDeviceLink 7.1.0
 * 			
 *
 * @see SubscribeVehicleData
 * @see GetVehicleData
 * @see OnVehicleData
 * @since SmartDeviceLink 2.0
 */

public class BodyInformation extends RPCStruct {
    public static final String KEY_PARK_BRAKE_ACTIVE = "parkBrakeActive";
    public static final String KEY_IGNITION_STABLE_STATUS = "ignitionStableStatus";
    public static final String KEY_IGNITION_STATUS = "ignitionStatus";
    /**
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public static final String KEY_DRIVER_DOOR_AJAR = "driverDoorAjar";
    /**
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public static final String KEY_PASSENGER_DOOR_AJAR = "passengerDoorAjar";
    /**
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public static final String KEY_REAR_LEFT_DOOR_AJAR = "rearLeftDoorAjar";
    /**
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public static final String KEY_REAR_RIGHT_DOOR_AJAR = "rearRightDoorAjar";
    /**
     * @since SmartDeviceLink 7.1.0
     */
    public static final String KEY_DOOR_STATUSES = "doorStatuses";
    /**
     * @since SmartDeviceLink 7.1.0
     */
    public static final String KEY_GATE_STATUSES = "gateStatuses";
    /**
     * @since SmartDeviceLink 7.1.0
     */
    public static final String KEY_ROOF_STATUSES = "roofStatuses";

    public BodyInformation() {
    }

    /**
     * Constructs a new BodyInformation object indicated by the Hashtable
     * parameter
     *
     * @param hash hashtable filled with params to create an instance of this RPC
     *             The hash table to use
     */
    public BodyInformation(Hashtable hash) {
        super(hash);
    }

    public BodyInformation(@NonNull Boolean parkBrakeActive, @NonNull IgnitionStableStatus ignitionStableStatus, @NonNull IgnitionStatus ignitionStatus) {
        this();
        setParkBrakeActive(parkBrakeActive);
        setIgnitionStableStatus(ignitionStableStatus);
        setIgnitionStatus(ignitionStatus);
    }

    public BodyInformation setParkBrakeActive(@NonNull Boolean parkBrakeActive) {
        setValue(KEY_PARK_BRAKE_ACTIVE, parkBrakeActive);
        return this;
    }

    public Boolean getParkBrakeActive() {
        return getBoolean(KEY_PARK_BRAKE_ACTIVE);
    }

    public BodyInformation setIgnitionStableStatus(@NonNull IgnitionStableStatus ignitionStableStatus) {
        setValue(KEY_IGNITION_STABLE_STATUS, ignitionStableStatus);
        return this;
    }

    public IgnitionStableStatus getIgnitionStableStatus() {
        return (IgnitionStableStatus) getObject(IgnitionStableStatus.class, KEY_IGNITION_STABLE_STATUS);
    }

    public BodyInformation setIgnitionStatus(@NonNull IgnitionStatus ignitionStatus) {
        setValue(KEY_IGNITION_STATUS, ignitionStatus);
        return this;
    }

    public IgnitionStatus getIgnitionStatus() {
        return (IgnitionStatus) getObject(IgnitionStatus.class, KEY_IGNITION_STATUS);
    }

    /**
     * Sets the driverDoorAjar.
     *
     * @param driverDoorAjar References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public BodyInformation setDriverDoorAjar(Boolean driverDoorAjar) {
        setValue(KEY_DRIVER_DOOR_AJAR, driverDoorAjar);
        return this;
    }

    /**
     * Gets the driverDoorAjar.
     *
     * @return Boolean References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public Boolean getDriverDoorAjar() {
        return getBoolean(KEY_DRIVER_DOOR_AJAR);
    }

    /**
     * Sets the passengerDoorAjar.
     *
     * @param passengerDoorAjar References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public BodyInformation setPassengerDoorAjar(Boolean passengerDoorAjar) {
        setValue(KEY_PASSENGER_DOOR_AJAR, passengerDoorAjar);
        return this;
    }

    /**
     * Gets the passengerDoorAjar.
     *
     * @return Boolean References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public Boolean getPassengerDoorAjar() {
        return getBoolean(KEY_PASSENGER_DOOR_AJAR);
    }

    /**
     * Sets the rearLeftDoorAjar.
     *
     * @param rearLeftDoorAjar References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public BodyInformation setRearLeftDoorAjar(Boolean rearLeftDoorAjar) {
        setValue(KEY_REAR_LEFT_DOOR_AJAR, rearLeftDoorAjar);
        return this;
    }

    /**
     * Gets the rearLeftDoorAjar.
     *
     * @return Boolean References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public Boolean getRearLeftDoorAjar() {
        return getBoolean(KEY_REAR_LEFT_DOOR_AJAR);
    }

    /**
     * Sets the rearRightDoorAjar.
     *
     * @param rearRightDoorAjar References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public BodyInformation setRearRightDoorAjar(Boolean rearRightDoorAjar) {
        setValue(KEY_REAR_RIGHT_DOOR_AJAR, rearRightDoorAjar);
        return this;
    }

    /**
     * Gets the rearRightDoorAjar.
     *
     * @return Boolean References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
     * @since SmartDeviceLink 2.0.0
     * @deprecated in SmartDeviceLink 7.1.0
     */
    @Deprecated
    public Boolean getRearRightDoorAjar() {
        return getBoolean(KEY_REAR_RIGHT_DOOR_AJAR);
    }

    /**
     * Sets the doorStatuses.
     *
     * @param doorStatuses Provides status for doors if Ajar/Closed/Locked
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    public BodyInformation setDoorStatuses(List doorStatuses) {
        setValue(KEY_DOOR_STATUSES, doorStatuses);
        return this;
    }

    /**
     * Gets the doorStatuses.
     *
     * @return List Provides status for doors if Ajar/Closed/Locked
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    @SuppressWarnings("unchecked")
    public List getDoorStatuses() {
        return (List) getObject(DoorStatus.class, KEY_DOOR_STATUSES);
    }

    /**
     * Sets the gateStatuses.
     *
     * @param gateStatuses Provides status for trunk/hood/etc. if Ajar/Closed/Locked
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    public BodyInformation setGateStatuses(List gateStatuses) {
        setValue(KEY_GATE_STATUSES, gateStatuses);
        return this;
    }

    /**
     * Gets the gateStatuses.
     *
     * @return List Provides status for trunk/hood/etc. if Ajar/Closed/Locked
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    @SuppressWarnings("unchecked")
    public List getGateStatuses() {
        return (List) getObject(GateStatus.class, KEY_GATE_STATUSES);
    }

    /**
     * Sets the roofStatuses.
     *
     * @param roofStatuses Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed
     * etc.
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    public BodyInformation setRoofStatuses(List roofStatuses) {
        setValue(KEY_ROOF_STATUSES, roofStatuses);
        return this;
    }

    /**
     * Gets the roofStatuses.
     *
     * @return List Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed
     * etc.
     * {"array_min_size": 0, "array_max_size": 100}
     * @since SmartDeviceLink 7.1.0
     */
    @SuppressWarnings("unchecked")
    public List getRoofStatuses() {
        return (List) getObject(RoofStatus.class, KEY_ROOF_STATUSES);
    }
}

Param Name	Type	Mandatory	Description	Version
ignitionStableStatus	IgnitionStableStatus	true	Describes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}	SmartDeviceLink 2.0
ignitionStatus	IgnitionStatus	true	The information about ignition status. See {@linkplain IgnitionStatus}	SmartDeviceLink 2.0
parkBrakeActive	Boolean	true	The information about the park brake: - true, if active - false if not.	SmartDeviceLink 2.0
driverDoorAjar	Boolean	false	The information about the park brake: - true, if active - false if not.	* SmartDeviceLink 2.0.0 * * * Deprecated in SmartDeviceLink 7.1.0 *
passengerDoorAjar	Boolean	false	The information about the park brake: - true, if active - false if not.	* SmartDeviceLink 2.0.0 * * * Deprecated in SmartDeviceLink 7.1.0 *
rearLeftDoorAjar	Boolean	false	The information about the park brake: - true, if active - false if not.	* SmartDeviceLink 2.0.0 * * * Deprecated in SmartDeviceLink 7.1.0 *
rearRightDoorAjar	Boolean	false	References signal "DrStatRr_B_Actl".	* SmartDeviceLink 2.0.0 * * * Deprecated in SmartDeviceLink 7.1.0 *
doorStatuses	List	False	Provides status for doors if Ajar/Closed/Locked * {"array_min_size": 0, "array_max_size": 100}	* SmartDeviceLink 7.1.0 *
gateStatuses	List	False	Provides status for trunk/hood/etc. if Ajar/Closed/Locked * {"array_min_size": 0, "array_max_size": 100}	* SmartDeviceLink 7.1.0 *
roofStatuses	List	False	Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/ Removedetc. * {"array_min_size": 0, "array_max_size": 100}	* SmartDeviceLink 7.1.0 *