Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
BodyInformation

Class BodyInformation

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

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 IgnitionStableStatus SmartDeviceLink 2.0
ignitionStatus IgnitionStatus true The information about ignition status. See 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

Fields

KEY_PARK_BRAKE_ACTIVE

public static final java.lang.String KEY_PARK_BRAKE_ACTIVE
Constant Value
"parkBrakeActive"

KEY_IGNITION_STABLE_STATUS

public static final java.lang.String KEY_IGNITION_STABLE_STATUS
Constant Value
"ignitionStableStatus"

KEY_IGNITION_STATUS

public static final java.lang.String KEY_IGNITION_STATUS
Constant Value
"ignitionStatus"

KEY_DRIVER_DOOR_AJAR

public static final java.lang.String KEY_DRIVER_DOOR_AJAR
Constant Value
"driverDoorAjar"

KEY_PASSENGER_DOOR_AJAR

public static final java.lang.String KEY_PASSENGER_DOOR_AJAR
Constant Value
"passengerDoorAjar"

KEY_REAR_LEFT_DOOR_AJAR

public static final java.lang.String KEY_REAR_LEFT_DOOR_AJAR
Constant Value
"rearLeftDoorAjar"

KEY_REAR_RIGHT_DOOR_AJAR

public static final java.lang.String KEY_REAR_RIGHT_DOOR_AJAR
Constant Value
"rearRightDoorAjar"

KEY_DOOR_STATUSES

public static final java.lang.String KEY_DOOR_STATUSES
Constant Value
"doorStatuses"

KEY_GATE_STATUSES

public static final java.lang.String KEY_GATE_STATUSES
Constant Value
"gateStatuses"

KEY_ROOF_STATUSES

public static final java.lang.String KEY_ROOF_STATUSES
Constant Value
"roofStatuses"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

BodyInformation()

public BodyInformation()

BodyInformation( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new BodyInformation object indicated by the Hashtable parameter

public BodyInformation(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
hashtable filled with params to create an instance of this RPC The hash table to use

BodyInformation( Boolean parkBrakeActive, IgnitionStableStatus ignitionStableStatus, IgnitionStatus ignitionStatus )

public BodyInformation(Boolean parkBrakeActive,IgnitionStableStatus ignitionStableStatus,IgnitionStatus ignitionStatus)

Constructor Parameters

parkBrakeActive
ignitionStableStatus
ignitionStatus

Methods

setParkBrakeActive( Boolean parkBrakeActive )

public com.smartdevicelink.proxy.rpc.BodyInformation setParkBrakeActive(Boolean parkBrakeActive)

Method Parameters

parkBrakeActive

getParkBrakeActive()

public java.lang.Boolean getParkBrakeActive()

setIgnitionStableStatus( IgnitionStableStatus ignitionStableStatus )

public com.smartdevicelink.proxy.rpc.BodyInformation setIgnitionStableStatus(IgnitionStableStatus ignitionStableStatus)

Method Parameters

ignitionStableStatus

getIgnitionStableStatus()

public com.smartdevicelink.proxy.rpc.enums.IgnitionStableStatus getIgnitionStableStatus()

setIgnitionStatus( IgnitionStatus ignitionStatus )

public com.smartdevicelink.proxy.rpc.BodyInformation setIgnitionStatus(IgnitionStatus ignitionStatus)

Method Parameters

ignitionStatus

getIgnitionStatus()

public com.smartdevicelink.proxy.rpc.enums.IgnitionStatus getIgnitionStatus()

setDriverDoorAjar( Boolean driverDoorAjar )

Deprecated
Sets the driverDoorAjar.

public com.smartdevicelink.proxy.rpc.BodyInformation setDriverDoorAjar(Boolean driverDoorAjar)

Method Parameters

driverDoorAjar
References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0.

getDriverDoorAjar()

Deprecated
Gets the driverDoorAjar.

public java.lang.Boolean getDriverDoorAjar()

setPassengerDoorAjar( Boolean passengerDoorAjar )

Deprecated
Sets the passengerDoorAjar.

public com.smartdevicelink.proxy.rpc.BodyInformation setPassengerDoorAjar(Boolean passengerDoorAjar)

Method Parameters

passengerDoorAjar
References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0.

getPassengerDoorAjar()

Deprecated
Gets the passengerDoorAjar.

public java.lang.Boolean getPassengerDoorAjar()

setRearLeftDoorAjar( Boolean rearLeftDoorAjar )

Deprecated
Sets the rearLeftDoorAjar.

public com.smartdevicelink.proxy.rpc.BodyInformation setRearLeftDoorAjar(Boolean rearLeftDoorAjar)

Method Parameters

rearLeftDoorAjar
References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0.

getRearLeftDoorAjar()

Deprecated
Gets the rearLeftDoorAjar.

public java.lang.Boolean getRearLeftDoorAjar()

setRearRightDoorAjar( Boolean rearRightDoorAjar )

Deprecated
Sets the rearRightDoorAjar.

public com.smartdevicelink.proxy.rpc.BodyInformation setRearRightDoorAjar(Boolean rearRightDoorAjar)

Method Parameters

rearRightDoorAjar
References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0.

getRearRightDoorAjar()

Deprecated
Gets the rearRightDoorAjar.

public java.lang.Boolean getRearRightDoorAjar()

setDoorStatuses( java.util.List<com.smartdevicelink.proxy.rpc.DoorStatus> doorStatuses )

Sets the doorStatuses.

public com.smartdevicelink.proxy.rpc.BodyInformation setDoorStatuses(java.util.List<com.smartdevicelink.proxy.rpc.DoorStatus> doorStatuses)

Method Parameters

doorStatuses
Provides status for doors if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}

getDoorStatuses()

Gets the doorStatuses.

public java.util.List getDoorStatuses()

setGateStatuses( java.util.List<com.smartdevicelink.proxy.rpc.GateStatus> gateStatuses )

Sets the gateStatuses.

public com.smartdevicelink.proxy.rpc.BodyInformation setGateStatuses(java.util.List<com.smartdevicelink.proxy.rpc.GateStatus> gateStatuses)

Method Parameters

gateStatuses
Provides status for trunk/hood/etc. if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}

getGateStatuses()

Gets the gateStatuses.

public java.util.List getGateStatuses()

setRoofStatuses( java.util.List<com.smartdevicelink.proxy.rpc.RoofStatus> roofStatuses )

Sets the roofStatuses.

public com.smartdevicelink.proxy.rpc.BodyInformation setRoofStatuses(java.util.List<com.smartdevicelink.proxy.rpc.RoofStatus> roofStatuses)

Method Parameters

roofStatuses
Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed etc. {"array_min_size": 0, "array_max_size": 100}

getRoofStatuses()

Gets the roofStatuses.

public java.util.List getRoofStatuses()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section