Package com.highmobility.autoapi

Class Usage.State.Builder

java.lang.Object
com.highmobility.autoapi.SetCommand.Builder<Usage.State.Builder>
com.highmobility.autoapi.Usage.State.Builder
Enclosing class:
Usage.State
public static final class Usage.State.Builder extends SetCommand.Builder<Usage.State.Builder>

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public Usage.State build()
      Overrides:
      build in class SetCommand.Builder<Usage.State.Builder>

    • setAverageWeeklyDistance

      public Usage.State.Builder setAverageWeeklyDistance(Property<com.highmobility.autoapi.value.measurement.Length> averageWeeklyDistance)
      Parameters:
      averageWeeklyDistance - Average weekly distance
      Returns:
      The builder

    • setAverageWeeklyDistanceLongRun

      public Usage.State.Builder setAverageWeeklyDistanceLongRun(Property<com.highmobility.autoapi.value.measurement.Length> averageWeeklyDistanceLongRun)
      Parameters:
      averageWeeklyDistanceLongRun - Average weekyl distance over long term
      Returns:
      The builder

    • setAccelerationEvaluation

      public Usage.State.Builder setAccelerationEvaluation(Property<Double> accelerationEvaluation)
      Parameters:
      accelerationEvaluation - Acceleration evaluation percentage
      Returns:
      The builder

    • setDrivingStyleEvaluation

      public Usage.State.Builder setDrivingStyleEvaluation(Property<Double> drivingStyleEvaluation)
      Parameters:
      drivingStyleEvaluation - Driving style evaluation percentage
      Returns:
      The builder

    • setDrivingModesActivationPeriods

      public Usage.State.Builder setDrivingModesActivationPeriods(Property<DrivingModeActivationPeriod>[] drivingModesActivationPeriods)
      Add an array of driving modes activation periods
      Parameters:
      drivingModesActivationPeriods - The driving modes activation periods
      Returns:
      The builder

    • addDrivingModesActivationPeriod

      public Usage.State.Builder addDrivingModesActivationPeriod(Property<DrivingModeActivationPeriod> drivingModesActivationPeriod)
      Add a single driving modes activation period
      Parameters:
      drivingModesActivationPeriod - The driving modes activation period
      Returns:
      The builder

    • setDrivingModesEnergyConsumptions

      public Usage.State.Builder setDrivingModesEnergyConsumptions(Property<DrivingModeEnergyConsumption>[] drivingModesEnergyConsumptions)
      Add an array of driving modes energy consumptions
      Parameters:
      drivingModesEnergyConsumptions - The driving modes energy consumptions
      Returns:
      The builder

    • addDrivingModeEnergyConsumption

      public Usage.State.Builder addDrivingModeEnergyConsumption(Property<DrivingModeEnergyConsumption> drivingModeEnergyConsumption)
      Add a single driving mode energy consumption
      Parameters:
      drivingModeEnergyConsumption - The driving mode energy consumption
      Returns:
      The builder

    • setLastTripEnergyConsumption

      public Usage.State.Builder setLastTripEnergyConsumption(Property<com.highmobility.autoapi.value.measurement.Energy> lastTripEnergyConsumption)
      Parameters:
      lastTripEnergyConsumption - Energy consumption in the last trip
      Returns:
      The builder

    • setLastTripFuelConsumption

      public Usage.State.Builder setLastTripFuelConsumption(Property<com.highmobility.autoapi.value.measurement.Volume> lastTripFuelConsumption)
      Parameters:
      lastTripFuelConsumption - Fuel consumption in the last trip
      Returns:
      The builder

    • setMileageAfterLastTrip

      @Deprecated public Usage.State.Builder setMileageAfterLastTrip(Property<com.highmobility.autoapi.value.measurement.Length> mileageAfterLastTrip)
      Deprecated.
      'mileage' is an incorrect term for this. Replaced by Usage.State.getOdometerAfterLastTrip()
      Parameters:
      mileageAfterLastTrip - Mileage after the last trip
      Returns:
      The builder

    • setLastTripElectricPortion

      public Usage.State.Builder setLastTripElectricPortion(Property<Double> lastTripElectricPortion)
      Parameters:
      lastTripElectricPortion - Portion of the last trip used in electric mode
      Returns:
      The builder

    • setLastTripAverageEnergyRecuperation

      public Usage.State.Builder setLastTripAverageEnergyRecuperation(Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> lastTripAverageEnergyRecuperation)
      Parameters:
      lastTripAverageEnergyRecuperation - Energy recuperation rate for last trip
      Returns:
      The builder

    • setLastTripBatteryRemaining

      public Usage.State.Builder setLastTripBatteryRemaining(Property<Double> lastTripBatteryRemaining)
      Parameters:
      lastTripBatteryRemaining - Battery % remaining after last trip
      Returns:
      The builder

    • setLastTripDate

      public Usage.State.Builder setLastTripDate(Property<Calendar> lastTripDate)
      Parameters:
      lastTripDate - The last trip date
      Returns:
      The builder

    • setAverageFuelConsumption

      public Usage.State.Builder setAverageFuelConsumption(Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> averageFuelConsumption)
      Parameters:
      averageFuelConsumption - Average fuel consumption for current trip
      Returns:
      The builder

    • setCurrentFuelConsumption

      public Usage.State.Builder setCurrentFuelConsumption(Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> currentFuelConsumption)
      Parameters:
      currentFuelConsumption - Current fuel consumption
      Returns:
      The builder

    • setOdometerAfterLastTrip

      public Usage.State.Builder setOdometerAfterLastTrip(Property<com.highmobility.autoapi.value.measurement.Length> odometerAfterLastTrip)
      Parameters:
      odometerAfterLastTrip - Odometer after the last trip
      Returns:
      The builder

    • setSafetyDrivingScore

      public Usage.State.Builder setSafetyDrivingScore(Property<Double> safetyDrivingScore)
      Parameters:
      safetyDrivingScore - Safety driving score as percentage
      Returns:
      The builder

    • setRapidAccelerationGrade

      public Usage.State.Builder setRapidAccelerationGrade(Property<Grade> rapidAccelerationGrade)
      Parameters:
      rapidAccelerationGrade - Grade given for rapid acceleration over time
      Returns:
      The builder

    • setRapidDecelerationGrade

      public Usage.State.Builder setRapidDecelerationGrade(Property<Grade> rapidDecelerationGrade)
      Parameters:
      rapidDecelerationGrade - Grade given for rapid deceleration over time
      Returns:
      The builder

    • setLateNightGrade

      public Usage.State.Builder setLateNightGrade(Property<Grade> lateNightGrade)
      Parameters:
      lateNightGrade - Grade given for late night driving over time
      Returns:
      The builder

    • setDistanceOverTime

      public Usage.State.Builder setDistanceOverTime(Property<DistanceOverTime> distanceOverTime)
      Parameters:
      distanceOverTime - Distance driven over a given time period
      Returns:
      The builder

    • setElectricConsumptionRateSinceStart

      public Usage.State.Builder setElectricConsumptionRateSinceStart(Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> electricConsumptionRateSinceStart)
      Parameters:
      electricConsumptionRateSinceStart - Electric energy consumption rate since the start of a trip
      Returns:
      The builder

    • setElectricConsumptionRateSinceReset

      public Usage.State.Builder setElectricConsumptionRateSinceReset(Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> electricConsumptionRateSinceReset)
      Parameters:
      electricConsumptionRateSinceReset - Electric energy consumption rate since a reset
      Returns:
      The builder

    • setElectricDistanceLastTrip

      public Usage.State.Builder setElectricDistanceLastTrip(Property<com.highmobility.autoapi.value.measurement.Length> electricDistanceLastTrip)
      Parameters:
      electricDistanceLastTrip - Distance travelled with electricity in last trip
      Returns:
      The builder

    • setElectricDistanceSinceReset

      public Usage.State.Builder setElectricDistanceSinceReset(Property<com.highmobility.autoapi.value.measurement.Length> electricDistanceSinceReset)
      Parameters:
      electricDistanceSinceReset - Distance travelled with electricity since reset
      Returns:
      The builder

    • setElectricDurationLastTrip

      public Usage.State.Builder setElectricDurationLastTrip(Property<com.highmobility.autoapi.value.measurement.Duration> electricDurationLastTrip)
      Parameters:
      electricDurationLastTrip - Duration of travelling using electricity during last trip
      Returns:
      The builder

    • setElectricDurationSinceReset

      public Usage.State.Builder setElectricDurationSinceReset(Property<com.highmobility.autoapi.value.measurement.Duration> electricDurationSinceReset)
      Parameters:
      electricDurationSinceReset - Duration of travelling using electricity since reset
      Returns:
      The builder

    • setFuelConsumptionRateLastTrip

      public Usage.State.Builder setFuelConsumptionRateLastTrip(Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> fuelConsumptionRateLastTrip)
      Parameters:
      fuelConsumptionRateLastTrip - Liquid fuel consumption rate during last trip
      Returns:
      The builder

    • setFuelConsumptionRateSinceReset

      public Usage.State.Builder setFuelConsumptionRateSinceReset(Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> fuelConsumptionRateSinceReset)
      Parameters:
      fuelConsumptionRateSinceReset - Liquid fuel consumption rate since reset
      Returns:
      The builder

    • setAverageSpeedLastTrip

      public Usage.State.Builder setAverageSpeedLastTrip(Property<com.highmobility.autoapi.value.measurement.Speed> averageSpeedLastTrip)
      Parameters:
      averageSpeedLastTrip - Average speed during last trip
      Returns:
      The builder

    • setAverageSpeedSinceReset

      public Usage.State.Builder setAverageSpeedSinceReset(Property<com.highmobility.autoapi.value.measurement.Speed> averageSpeedSinceReset)
      Parameters:
      averageSpeedSinceReset - Average speed since reset
      Returns:
      The builder

    • setFuelDistanceLastTrip

      public Usage.State.Builder setFuelDistanceLastTrip(Property<com.highmobility.autoapi.value.measurement.Length> fuelDistanceLastTrip)
      Parameters:
      fuelDistanceLastTrip - Distance travelled with (liquid) fuel during last trip
      Returns:
      The builder

    • setFuelDistanceSinceReset

      public Usage.State.Builder setFuelDistanceSinceReset(Property<com.highmobility.autoapi.value.measurement.Length> fuelDistanceSinceReset)
      Parameters:
      fuelDistanceSinceReset - Distance travelled with (liquid) fuel since reset
      Returns:
      The builder

    • setDrivingDurationLastTrip

      public Usage.State.Builder setDrivingDurationLastTrip(Property<com.highmobility.autoapi.value.measurement.Duration> drivingDurationLastTrip)
      Parameters:
      drivingDurationLastTrip - Duration of last trip
      Returns:
      The builder

    • setDrivingDurationSinceReset

      public Usage.State.Builder setDrivingDurationSinceReset(Property<com.highmobility.autoapi.value.measurement.Duration> drivingDurationSinceReset)
      Parameters:
      drivingDurationSinceReset - Duration of travelling since reset
      Returns:
      The builder

    • setEcoScoreTotal

      public Usage.State.Builder setEcoScoreTotal(Property<Double> ecoScoreTotal)
      Parameters:
      ecoScoreTotal - Overall eco-score rating
      Returns:
      The builder

    • setEcoScoreFreeWheel

      public Usage.State.Builder setEcoScoreFreeWheel(Property<Double> ecoScoreFreeWheel)
      Parameters:
      ecoScoreFreeWheel - Eco-score rating for free-wheeling
      Returns:
      The builder

    • setEcoScoreConstant

      public Usage.State.Builder setEcoScoreConstant(Property<Double> ecoScoreConstant)
      Parameters:
      ecoScoreConstant - Eco-score rating constant
      Returns:
      The builder

    • setEcoScoreBonusRange

      public Usage.State.Builder setEcoScoreBonusRange(Property<com.highmobility.autoapi.value.measurement.Length> ecoScoreBonusRange)
      Parameters:
      ecoScoreBonusRange - Eco-score bonus range
      Returns:
      The builder

    • setTripMeters

      public Usage.State.Builder setTripMeters(Property<TripMeter>[] tripMeters)
      Add an array of trip meters
      Parameters:
      tripMeters - The trip meters
      Returns:
      The builder

    • addTripMeter

      public Usage.State.Builder addTripMeter(Property<TripMeter> tripMeter)
      Add a single trip meter
      Parameters:
      tripMeter - The trip meter
      Returns:
      The builder

    • setElectricConsumptionAverage

      public Usage.State.Builder setElectricConsumptionAverage(Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> electricConsumptionAverage)
      Parameters:
      electricConsumptionAverage - Average electric energy consumption calculated based on the last 20km
      Returns:
      The builder

    • setBrakingEvaluation

      public Usage.State.Builder setBrakingEvaluation(Property<Double> brakingEvaluation)
      Parameters:
      brakingEvaluation - Braking evaluation percentage
      Returns:
      The builder

    • setAverageSpeed

      public Usage.State.Builder setAverageSpeed(Property<com.highmobility.autoapi.value.measurement.Speed> averageSpeed)
      Parameters:
      averageSpeed - Average speed at data collection.
      Returns:
      The builder

    • setRecuperationPower

      public Usage.State.Builder setRecuperationPower(Property<com.highmobility.autoapi.value.measurement.Power> recuperationPower)
      Parameters:
      recuperationPower - Recuperation energy of the drivetrain.
      Returns:
      The builder

    • setAccelerationDurations

      public Usage.State.Builder setAccelerationDurations(Property<AccelerationDuration>[] accelerationDurations)
      Add an array of acceleration durations
      Parameters:
      accelerationDurations - The acceleration durations. Durations of normal or other accelerations.
      Returns:
      The builder

    • addAccelerationDuration

      public Usage.State.Builder addAccelerationDuration(Property<AccelerationDuration> accelerationDuration)
      Add a single acceleration duration
      Parameters:
      accelerationDuration - The acceleration duration. Durations of normal or other accelerations.
      Returns:
      The builder