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
Documentation
FuelRange

Class FuelRange

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Parameter List

Param Name Type Description Required Notes Version Available
type FuelType N
range Float The estimate range in KM the vehicle can travel based on fuel level and consumption. N {"num_min_value": 0.0, "num_max_value": 10000.0}
level Float The relative remaining capacity of this fuel type (percentage). N {"num_min_value": -6.0, "num_max_value": 1000000.0} SmartDeviceLink 7.0.0
levelState ComponentVolumeStatus The fuel level state N SmartDeviceLink 7.0.0
capacity Float The absolute capacity of this fuel type. N {"num_min_value": 0.0, "num_max_value": 1000000.0} SmartDeviceLink 7.0.0
capacityUnit CapacityUnit The unit of the capacity of this fuel type such as liters for gasoline or kWh for batteries. N SmartDeviceLink 7.0.0

Fields

KEY_TYPE

public static final java.lang.String KEY_TYPE
Constant Value
"type"

KEY_RANGE

public static final java.lang.String KEY_RANGE
Constant Value
"range"

KEY_LEVEL

public static final java.lang.String KEY_LEVEL
Constant Value
"level"

KEY_LEVEL_STATE

public static final java.lang.String KEY_LEVEL_STATE
Constant Value
"levelState"

KEY_CAPACITY

public static final java.lang.String KEY_CAPACITY
Constant Value
"capacity"

KEY_CAPACITY_UNIT

public static final java.lang.String KEY_CAPACITY_UNIT
Constant Value
"capacityUnit"

Inherited Fields

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

Constructors

FuelRange()

Constructs a new FuelRange object

public FuelRange()

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

Constructs a new FuelRange object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setType( FuelType fuelType )

Sets the type portion of the FuelRange class

public com.smartdevicelink.proxy.rpc.FuelRange setType(FuelType fuelType)

Parameters

fuelType
the type of fuel related to this FuelRange object.

getType()

Gets the type portion of the FuelRange class

public com.smartdevicelink.proxy.rpc.enums.FuelType getType()

getRange()

Gets the range portion of the FuelRange class

public java.lang.Float getRange()

setRange( Float range )

Sets the range portion of the FuelRange class

public com.smartdevicelink.proxy.rpc.FuelRange setRange(Float range)

Parameters

range
The estimate range in KM the vehicle can travel based on fuel level and consumption.

setLevel( Float level )

Sets the level.

public com.smartdevicelink.proxy.rpc.FuelRange setLevel(Float level)

Parameters

level
The relative remaining capacity of this fuel type (percentage). {"num_min_value": -6.0, "num_max_value": 1000000.0}

getLevel()

Gets the level.

public java.lang.Float getLevel()

setLevelState( ComponentVolumeStatus levelState )

Sets the levelState.

public com.smartdevicelink.proxy.rpc.FuelRange setLevelState(ComponentVolumeStatus levelState)

Parameters

levelState
The fuel level state

getLevelState()

Gets the levelState.

public com.smartdevicelink.proxy.rpc.enums.ComponentVolumeStatus getLevelState()

setCapacity( Float capacity )

Sets the capacity.

public com.smartdevicelink.proxy.rpc.FuelRange setCapacity(Float capacity)

Parameters

capacity
The absolute capacity of this fuel type. {"num_min_value": 0.0, "num_max_value": 1000000.0}

getCapacity()

Gets the capacity.

public java.lang.Float getCapacity()

setCapacityUnit( CapacityUnit capacityUnit )

Sets the capacityUnit.

public com.smartdevicelink.proxy.rpc.FuelRange setCapacityUnit(CapacityUnit capacityUnit)

Parameters

capacityUnit
The unit of the capacity of this fuel type such as liters for gasoline or kWh for batteries.

getCapacityUnit()

Gets the capacityUnit.

public com.smartdevicelink.proxy.rpc.enums.CapacityUnit getCapacityUnit()

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
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section