BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.external.units/UnitBuilder

UnitBuilder

class UnitBuilder<U : Unit<U>?>

Builder used for easily deriving new units from existing ones. When deriving a new unit, the base unit class must redeclare the constructor (U, UnaryFunction, UnaryFunction, String, String). The unit builder class will invoke this constructor automatically and build the new unit. Alternatively, new units can be derived by passing an explicit constructor function to make.

Since

1.0.0-pre

Parameters

<U>

the type of the unit

Constructors

constructor(base: U)

Creates a new unit builder object, building off of a base unit.

Types

open inner class MappingBuilder

Helper class used for safely chaining mapping builder calls.

UnitConstructorFunction

@FunctionalInterface

interface UnitConstructorFunction<U : Unit<U>?>

A functional interface for constructing new units without relying on reflection.

Functions

open fun aggregate(aggregation: Double): UnitBuilder<U>

Helper for defining units that are a scalar multiple of the base unit, such as kilometers being 1000x of the base unit (meters).

open fun fromBase(@NonNull fromBase: UnaryFunction): UnitBuilder<U>

Sets the conversion function to transform values in the base unit to values in the derived unit.

open fun make(): U

Creates the new unit based off of the builder methods called prior.

open fun make(@NonNull constructor: UnitBuilder.UnitConstructorFunction<U>): U

Creates the new unit based off of the builder methods called prior, passing them to a provided constructor function.

mappingInputRange

open fun mappingInputRange(minBase: Double, maxBase: Double): UnitBuilder.MappingBuilder

Defines a mapping for values within the given input range.

open fun named(@NonNull name: String): UnitBuilder<U>

Sets the name of the new unit.

open fun offset(offset: Double): UnitBuilder<U>

Sets the unit conversions based on a simple offset.

open fun splitInto(fraction: Double): UnitBuilder<U>

Helper for defining units that are a scalar fraction of the base unit, such as centimeters being 1/100th of the base unit (meters).

open fun symbol(@NonNull symbol: String): UnitBuilder<U>

Sets the symbol of the new unit.

open fun toBase(@NonNull toBase: UnaryFunction): UnitBuilder<U>

Sets the conversion function to transform values in the derived unit to values in the base unit.