com.smartdevicelink.proxy.rpc

Class RoofStatus

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.RoofStatus

All Implemented Interfaces:

Cloneable

public class RoofStatus
extends RPCStruct

Describes the status of a parameter of roof/convertible roof/sunroof/moonroof etc. If roof is open (AJAR), state will determine percentage of roof open.

Parameter List

Param Name	Type	Description	Required	Notes	Version Available
location	Grid		Y
status	DoorStatusType		Y
state	WindowState		N

Since:

SmartDeviceLink 7.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_LOCATION
static String	KEY_STATE
static String	KEY_STATUS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
RoofStatus() Constructs a new RoofStatus object
RoofStatus(Grid location, DoorStatusType status) Constructs a new RoofStatus object
RoofStatus(Hashtable<String,Object> hash) Constructs a new RoofStatus object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Grid	getLocation() Gets the location.
WindowState	getState() Gets the state.
DoorStatusType	getStatus() Gets the status.
RoofStatus	setLocation(Grid location) Sets the location.
RoofStatus	setState(WindowState state) Sets the state.
RoofStatus	setStatus(DoorStatusType status) Sets the status.

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_LOCATION

public static final String KEY_LOCATION

See Also:

Constant Field Values

KEY_STATUS

public static final String KEY_STATUS

See Also:

Constant Field Values

KEY_STATE

public static final String KEY_STATE

See Also:

Constant Field Values

Constructor Detail

RoofStatus

public RoofStatus()

Constructs a new RoofStatus object

RoofStatus

public RoofStatus(Hashtable<String,Object> hash)

Constructs a new RoofStatus object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

RoofStatus

public RoofStatus(@NonNull
                  Grid location,
                  @NonNull
                  DoorStatusType status)

Constructs a new RoofStatus object

Parameters:

location -

status -

Method Detail

setLocation

public RoofStatus setLocation(@NonNull
                              Grid location)

Sets the location.

Parameters:

location -

getLocation

public Grid getLocation()

Gets the location.

Returns:

Grid

setStatus

public RoofStatus setStatus(@NonNull
                            DoorStatusType status)

Sets the status.

Parameters:

status -

getStatus

public DoorStatusType getStatus()

Gets the status.

Returns:

DoorStatusType

setState

public RoofStatus setState(WindowState state)

Sets the state.

Parameters:

state -

getState

public WindowState getState()

Gets the state.

Returns:

WindowState