CombustionEngine

public class CombustionEngine

A combustion vehicle engine for route planning and consumption estimation.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(consumption:efficiency:currentFuel:)

Declaration

Swift

public init(
    consumption: Consumption? = nil,
    efficiency: CombustionVehicleEfficiency? = nil,
    currentFuel: Measurement<UnitVolume>? = nil
)

Parameters

`consumption`	Specifies the consumption model of the vehicle.
`efficiency`	Specifies the efficiency of the engine.
`currentFuel`	Current amount of fuel, for example in liters.

Public


                    
                    
                    Consumption

Describes the capacity and consumption of a combustion vehicle.

Declaration

Swift

public typealias Consumption = ConsumptionModel<UnitFuelEfficiency, TTUnitFuelPerTime>

consumption
Specifies the consumption model of the vehicle.
Declaration
Swift

public let consumption: Consumption?
efficiency
Specifies the efficiency of the engine.
Declaration
Swift

public let efficiency: CombustionVehicleEfficiency?
currentFuel
Current amount of fuel, for example in liters.
Declaration
Swift

public let currentFuel: Measurement<UnitVolume>?

CombustionEngine


                    
                    
                    copy(build:)

Copies the current CombustionEngine with changes specified in build closure

Declaration

Swift

public func copy(build: (inout Builder) -> ()) -> CombustionEngine

Parameters


                                build

This closure allows for change of CombustionEngine values

Return Value

CombustionEngine with the changes set on the closure

Builder
The Builder creates a new instance of CombustionEngine with modified fields.
Declaration
Swift

public struct Builder