FuelRange Class Reference
Constructors
Instance Methods
- getCapacity() ⇒
Number - getCapacityUnit() ⇒
CapacityUnit - getLevel() ⇒
Number - getLevelState() ⇒
ComponentVolumeStatus - getRange() ⇒
Number - getType() ⇒
FuelType - setCapacity(capacity) ⇒
FuelRange - setCapacityUnit(unit) ⇒
FuelRange - setLevel(level) ⇒
FuelRange - setLevelState(state) ⇒
FuelRange - setRange(range) ⇒
FuelRange - setType(type) ⇒
FuelRange
Instance Methods
fuelRange.getCapacity() ⇒ Number
Get the Capacity
Kind: Instance method of FuelRange
Returns: Number - the KEY_CAPACITY value
fuelRange.getCapacityUnit() ⇒ CapacityUnit
Get the CapacityUnit
Kind: Instance method of FuelRange
Returns: CapacityUnit - the KEY_CAPACITY_UNIT value
fuelRange.getLevel() ⇒ Number
Get the Level
Kind: Instance method of FuelRange
Returns: Number - the KEY_LEVEL value
fuelRange.getLevelState() ⇒ ComponentVolumeStatus
Get the LevelState
Kind: Instance method of FuelRange
Returns: ComponentVolumeStatus - the KEY_LEVEL_STATE value
fuelRange.getRange() ⇒ Number
Get the Range
Kind: Instance method of FuelRange
Returns: Number - the KEY_RANGE value
fuelRange.getType() ⇒ FuelType
Get the Type
Kind: Instance method of FuelRange
Returns: FuelType - the KEY_TYPE value
fuelRange.setCapacity(capacity) ⇒ FuelRange
Set the Capacity
Kind: Instance method of FuelRange
Returns: FuelRange - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capacity | Number |
The absolute capacity of this fuel type. - The desired Capacity. {'num_min_value': 0.0, 'num_max_value': 1000000.0} |
fuelRange.setCapacityUnit(unit) ⇒ FuelRange
Set the CapacityUnit
Kind: Instance method of FuelRange
Returns: FuelRange - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| unit | CapacityUnit |
The unit of the capacity of this fuel type such as liters for gasoline or kWh for batteries. - The desired CapacityUnit. |
fuelRange.setLevel(level) ⇒ FuelRange
Set the Level
Kind: Instance method of FuelRange
Returns: FuelRange - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| level | Number |
The relative remaining capacity of this fuel type (percentage). - The desired Level. {'num_min_value': -6.0, 'num_max_value': 1000000.0} |
fuelRange.setLevelState(state) ⇒ FuelRange
Set the LevelState
Kind: Instance method of FuelRange
Returns: FuelRange - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| state | ComponentVolumeStatus |
The fuel level state - The desired LevelState. |
fuelRange.setRange(range) ⇒ FuelRange
Set the Range
Kind: Instance method of FuelRange
Returns: FuelRange - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| range | Number |
The estimate range in KM the vehicle can travel based on fuel level and consumption. - The desired Range. {'num_min_value': 0.0, 'num_max_value': 10000.0} |