com.smartdevicelink.proxy.rpc

Class FuelRange

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.FuelRange

All Implemented Interfaces:

Cloneable

public class FuelRange
extends RPCStruct

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

Since:

SmartDeviceLink 5.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CAPACITY
static String	KEY_CAPACITY_UNIT
static String	KEY_LEVEL
static String	KEY_LEVEL_STATE
static String	KEY_RANGE
static String	KEY_TYPE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
FuelRange() Constructs a new FuelRange object
FuelRange(Hashtable<String,Object> hash) Constructs a new FuelRange object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Float	getCapacity() Gets the capacity.
CapacityUnit	getCapacityUnit() Gets the capacityUnit.
Float	getLevel() Gets the level.
ComponentVolumeStatus	getLevelState() Gets the levelState.
Float	getRange() Gets the range portion of the FuelRange class
FuelType	getType() Gets the type portion of the FuelRange class
FuelRange	setCapacity(Float capacity) Sets the capacity.
FuelRange	setCapacityUnit(CapacityUnit capacityUnit) Sets the capacityUnit.
FuelRange	setLevel(Float level) Sets the level.
FuelRange	setLevelState(ComponentVolumeStatus levelState) Sets the levelState.
FuelRange	setRange(Float range) Sets the range portion of the FuelRange class
FuelRange	setType(FuelType fuelType) Sets the type portion of the FuelRange class

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_TYPE

public static final String KEY_TYPE

See Also:

Constant Field Values

KEY_RANGE

public static final String KEY_RANGE

See Also:

Constant Field Values

KEY_LEVEL

public static final String KEY_LEVEL

See Also:

Constant Field Values

KEY_LEVEL_STATE

public static final String KEY_LEVEL_STATE

See Also:

Constant Field Values

KEY_CAPACITY

public static final String KEY_CAPACITY

See Also:

Constant Field Values

KEY_CAPACITY_UNIT

public static final String KEY_CAPACITY_UNIT

See Also:

Constant Field Values

Constructor Detail

FuelRange

public FuelRange()

Constructs a new FuelRange object

FuelRange

public FuelRange(Hashtable<String,Object> hash)

Constructs a new FuelRange object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

setType

public FuelRange setType(FuelType fuelType)

Sets the type portion of the FuelRange class

Parameters:

fuelType - the type of fuel related to this FuelRange object.

See Also:

FuelType

getType

public FuelType getType()

Gets the type portion of the FuelRange class

Returns:

FuelType.

getRange

public Float getRange()

Gets the range portion of the FuelRange class

Returns:

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

setRange

public FuelRange setRange(Float range)

Sets the range portion of the FuelRange class

Parameters:

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

setLevel

public FuelRange setLevel(Float level)

Sets the level.

Parameters:

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

Since:

SmartDeviceLink 7.0.0

getLevel

public Float getLevel()

Gets the level.

Returns:

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

Since:

SmartDeviceLink 7.0.0

setLevelState

public FuelRange setLevelState(ComponentVolumeStatus levelState)

Sets the levelState.

Parameters:

levelState - The fuel level state

Since:

SmartDeviceLink 7.0.0

getLevelState

public ComponentVolumeStatus getLevelState()

Gets the levelState.

Returns:

ComponentVolumeStatus The fuel level state

Since:

SmartDeviceLink 7.0.0

setCapacity

public FuelRange setCapacity(Float capacity)

Sets the capacity.

Parameters:

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

Since:

SmartDeviceLink 7.0.0

getCapacity

public Float getCapacity()

Gets the capacity.

Returns:

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

Since:

SmartDeviceLink 7.0.0

setCapacityUnit

public FuelRange setCapacityUnit(CapacityUnit capacityUnit)

Sets the capacityUnit.

Parameters:

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

Since:

SmartDeviceLink 7.0.0

getCapacityUnit

public CapacityUnit getCapacityUnit()

Gets the capacityUnit.

Returns:

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

Since:

SmartDeviceLink 7.0.0