BodyInformation (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.BodyInformation

All Implemented Interfaces:: Cloneable

public class BodyInformation
extends RPCStruct

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
parkBrakeActive	Boolean	true	Describes, if the park break is active. The information about the park brake: - true, if active - false if not.	SmartDeviceLink 2.0
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	true	The information about the park brake: - true, if active - false if not.	Since: SmartDeviceLink 2.0.0, SmartDeviceLink 2.0.0, SmartDeviceLink 2.0.0, SmartDeviceLink 2.0.0, SmartDeviceLink 7.1.0
gateStatuses	List	Provides status for trunk/hood/etc. if Ajar/Closed/Locked	N	{"array_min_size": 0, "array_max_size": 100}	, SmartDeviceLink 7.1.0
roofStatuses	List	Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.	N	{"array_min_size": 0, "array_max_size": 100}	, SmartDeviceLink 7.1.0

, SmartDeviceLink 2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_DOOR_STATUSES`
`static String`	`KEY_DRIVER_DOOR_AJAR` Deprecated. in SmartDeviceLink 7.1.0
`static String`	`KEY_GATE_STATUSES`
`static String`	`KEY_IGNITION_STABLE_STATUS`
`static String`	`KEY_IGNITION_STATUS`
`static String`	`KEY_PARK_BRAKE_ACTIVE`
`static String`	`KEY_PASSENGER_DOOR_AJAR` Deprecated. in SmartDeviceLink 7.1.0
`static String`	`KEY_REAR_LEFT_DOOR_AJAR` Deprecated. in SmartDeviceLink 7.1.0
`static String`	`KEY_REAR_RIGHT_DOOR_AJAR` Deprecated. in SmartDeviceLink 7.1.0
`static String`	`KEY_ROOF_STATUSES`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`BodyInformation()`
`BodyInformation(Boolean parkBrakeActive, IgnitionStableStatus ignitionStableStatus, IgnitionStatus ignitionStatus)`
`BodyInformation(Hashtable<String,Object> hash)` Constructs a new BodyInformation object indicated by the Hashtable parameter

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<DoorStatus>`	`getDoorStatuses()` Gets the doorStatuses.
`Boolean`	`getDriverDoorAjar()` Deprecated. in SmartDeviceLink 7.1.0
`List<GateStatus>`	`getGateStatuses()` Gets the gateStatuses.
`IgnitionStableStatus`	`getIgnitionStableStatus()`
`IgnitionStatus`	`getIgnitionStatus()`
`Boolean`	`getParkBrakeActive()`
`Boolean`	`getPassengerDoorAjar()` Deprecated. in SmartDeviceLink 7.1.0
`Boolean`	`getRearLeftDoorAjar()` Deprecated. in SmartDeviceLink 7.1.0
`Boolean`	`getRearRightDoorAjar()` Deprecated. in SmartDeviceLink 7.1.0
`List<RoofStatus>`	`getRoofStatuses()` Gets the roofStatuses.
`BodyInformation`	`setDoorStatuses(List<DoorStatus> doorStatuses)` Sets the doorStatuses.
`BodyInformation`	`setDriverDoorAjar(Boolean driverDoorAjar)` Deprecated. in SmartDeviceLink 7.1.0
`BodyInformation`	`setGateStatuses(List<GateStatus> gateStatuses)` Sets the gateStatuses.
`BodyInformation`	`setIgnitionStableStatus(IgnitionStableStatus ignitionStableStatus)`
`BodyInformation`	`setIgnitionStatus(IgnitionStatus ignitionStatus)`
`BodyInformation`	`setParkBrakeActive(Boolean parkBrakeActive)`
`BodyInformation`	`setPassengerDoorAjar(Boolean passengerDoorAjar)` Deprecated. in SmartDeviceLink 7.1.0
`BodyInformation`	`setRearLeftDoorAjar(Boolean rearLeftDoorAjar)` Deprecated. in SmartDeviceLink 7.1.0
`BodyInformation`	`setRearRightDoorAjar(Boolean rearRightDoorAjar)` Deprecated. in SmartDeviceLink 7.1.0
`BodyInformation`	`setRoofStatuses(List<RoofStatus> roofStatuses)` Sets the roofStatuses.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_PARK_BRAKE_ACTIVE
```
public static final String KEY_PARK_BRAKE_ACTIVE
```
    See Also:
    
    Constant Field Values
  - KEY_IGNITION_STABLE_STATUS
```
public static final String KEY_IGNITION_STABLE_STATUS
```
    See Also:
    
    Constant Field Values
  - KEY_IGNITION_STATUS
```
public static final String KEY_IGNITION_STATUS
```
    See Also:
    
    Constant Field Values
  - KEY_DRIVER_DOOR_AJAR
```
@Deprecated
public static final String KEY_DRIVER_DOOR_AJAR
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Since:
    
    SmartDeviceLink 2.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_PASSENGER_DOOR_AJAR
```
@Deprecated
public static final String KEY_PASSENGER_DOOR_AJAR
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Since:
    
    SmartDeviceLink 2.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_REAR_LEFT_DOOR_AJAR
```
@Deprecated
public static final String KEY_REAR_LEFT_DOOR_AJAR
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Since:
    
    SmartDeviceLink 2.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_REAR_RIGHT_DOOR_AJAR
```
@Deprecated
public static final String KEY_REAR_RIGHT_DOOR_AJAR
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Since:
    
    SmartDeviceLink 2.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_DOOR_STATUSES
```
public static final String KEY_DOOR_STATUSES
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
  - KEY_GATE_STATUSES
```
public static final String KEY_GATE_STATUSES
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
  - KEY_ROOF_STATUSES
```
public static final String KEY_ROOF_STATUSES
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BodyInformation
```
public BodyInformation()
```
  - BodyInformation
```
public BodyInformation(Hashtable<String,Object> hash)
```
    Constructs a new BodyInformation object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - hashtable filled with params to create an instance of this RPC The hash table to use
  - BodyInformation
```
public BodyInformation(@NonNull
                       Boolean parkBrakeActive,
                       @NonNull
                       IgnitionStableStatus ignitionStableStatus,
                       @NonNull
                       IgnitionStatus ignitionStatus)
```
- Method Detail
  - setParkBrakeActive
```
public BodyInformation setParkBrakeActive(@NonNull
                                          Boolean parkBrakeActive)
```
  - getParkBrakeActive
```
public Boolean getParkBrakeActive()
```
  - setIgnitionStableStatus
```
public BodyInformation setIgnitionStableStatus(@NonNull
                                               IgnitionStableStatus ignitionStableStatus)
```
  - getIgnitionStableStatus
```
public IgnitionStableStatus getIgnitionStableStatus()
```
  - setIgnitionStatus
```
public BodyInformation setIgnitionStatus(@NonNull
                                         IgnitionStatus ignitionStatus)
```
  - getIgnitionStatus
```
public IgnitionStatus getIgnitionStatus()
```
  - setDriverDoorAjar
```
@Deprecated
public BodyInformation setDriverDoorAjar(Boolean driverDoorAjar)
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Sets the driverDoorAjar.
    
    Parameters:
    
    driverDoorAjar - References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getDriverDoorAjar
```
@Deprecated
public Boolean getDriverDoorAjar()
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Gets the driverDoorAjar.
    
    Returns:
    
    Boolean References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setPassengerDoorAjar
```
@Deprecated
public BodyInformation setPassengerDoorAjar(Boolean passengerDoorAjar)
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Sets the passengerDoorAjar.
    
    Parameters:
    
    passengerDoorAjar - References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getPassengerDoorAjar
```
@Deprecated
public Boolean getPassengerDoorAjar()
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Gets the passengerDoorAjar.
    
    Returns:
    
    Boolean References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setRearLeftDoorAjar
```
@Deprecated
public BodyInformation setRearLeftDoorAjar(Boolean rearLeftDoorAjar)
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Sets the rearLeftDoorAjar.
    
    Parameters:
    
    rearLeftDoorAjar - References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getRearLeftDoorAjar
```
@Deprecated
public Boolean getRearLeftDoorAjar()
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Gets the rearLeftDoorAjar.
    
    Returns:
    
    Boolean References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setRearRightDoorAjar
```
@Deprecated
public BodyInformation setRearRightDoorAjar(Boolean rearRightDoorAjar)
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Sets the rearRightDoorAjar.
    
    Parameters:
    
    rearRightDoorAjar - References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - getRearRightDoorAjar
```
@Deprecated
public Boolean getRearRightDoorAjar()
```
    Deprecated. in SmartDeviceLink 7.1.0
    
    Gets the rearRightDoorAjar.
    
    Returns:
    
    Boolean References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0.
    
    Since:
    
    SmartDeviceLink 2.0.0
  - setDoorStatuses
```
public BodyInformation setDoorStatuses(List<DoorStatus> doorStatuses)
```
    Sets the doorStatuses.
    
    Parameters:
    
    doorStatuses - Provides status for doors if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getDoorStatuses
```
public List<DoorStatus> getDoorStatuses()
```
    Gets the doorStatuses.
    
    Returns:
    
    List Provides status for doors if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setGateStatuses
```
public BodyInformation setGateStatuses(List<GateStatus> gateStatuses)
```
    Sets the gateStatuses.
    
    Parameters:
    
    gateStatuses - Provides status for trunk/hood/etc. if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getGateStatuses
```
public List<GateStatus> getGateStatuses()
```
    Gets the gateStatuses.
    
    Returns:
    
    List Provides status for trunk/hood/etc. if Ajar/Closed/Locked {"array_min_size": 0, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setRoofStatuses
```
public BodyInformation setRoofStatuses(List<RoofStatus> roofStatuses)
```
    Sets the roofStatuses.
    
    Parameters:
    
    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
  - getRoofStatuses
```
public List<RoofStatus> getRoofStatuses()
```
    Gets the roofStatuses.
    
    Returns:
    
    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

Class BodyInformation

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_PARK_BRAKE_ACTIVE

KEY_IGNITION_STABLE_STATUS

KEY_IGNITION_STATUS

KEY_DRIVER_DOOR_AJAR

KEY_PASSENGER_DOOR_AJAR

KEY_REAR_LEFT_DOOR_AJAR

KEY_REAR_RIGHT_DOOR_AJAR

KEY_DOOR_STATUSES

KEY_GATE_STATUSES

KEY_ROOF_STATUSES

Constructor Detail

BodyInformation

BodyInformation

BodyInformation

Method Detail

setParkBrakeActive

getParkBrakeActive

setIgnitionStableStatus

getIgnitionStableStatus

setIgnitionStatus

getIgnitionStatus

setDriverDoorAjar

getDriverDoorAjar

setPassengerDoorAjar

getPassengerDoorAjar

setRearLeftDoorAjar

getRearLeftDoorAjar

setRearRightDoorAjar

getRearRightDoorAjar

setDoorStatuses

getDoorStatuses

setGateStatuses

getGateStatuses

setRoofStatuses

getRoofStatuses