Package edu.wpi.first.units.measure
Interface Current
- All Superinterfaces:
Comparable<Measure<CurrentUnit>>
,Measure<CurrentUnit>
- All Known Implementing Classes:
ImmutableCurrent
,MutCurrent
-
Field Summary
Fields inherited from interface edu.wpi.first.units.Measure
EQUIVALENCE_THRESHOLD
-
Method Summary
Modifier and TypeMethodDescriptiondefault CurrentUnit
baseUnit()
A convenience method to get the base unit of the measurement.copy()
Returns an immutable copy of this measure.default Current
div
(double divisor) Divides this measure by a unitless scalar and returns the result.default Per<CurrentUnit,
AccelerationUnit<?>> div
(Acceleration<?> divisor) Divides this measure by a generic acceleration and returns the result in the most appropriate unit.default Per<CurrentUnit,
AngleUnit> Divides this measure by an angle and returns the result in the most appropriate unit.default Per<CurrentUnit,
AngularAccelerationUnit> div
(AngularAcceleration divisor) Divides this measure by an angular acceleration and returns the result in the most appropriate unit.default Per<CurrentUnit,
AngularMomentumUnit> div
(AngularMomentum divisor) Divides this measure by an angular momentum and returns the result in the most appropriate unit.default Per<CurrentUnit,
AngularVelocityUnit> div
(AngularVelocity divisor) Divides this measure by an angular velocity and returns the result in the most appropriate unit.default Dimensionless
Divides this measure by an electric current and returns the result in the most appropriate unit.default Current
div
(Dimensionless divisor) Divides this measure by a dimensionless scalar and returns the result.default Per<CurrentUnit,
DistanceUnit> Divides this measure by a distance and returns the result in the most appropriate unit.default Per<CurrentUnit,
EnergyUnit> Divides this measure by an energy and returns the result in the most appropriate unit.default Per<CurrentUnit,
ForceUnit> Divides this measure by a force and returns the result in the most appropriate unit.default Per<CurrentUnit,
FrequencyUnit> Divides this measure by a frequency and returns the result in the most appropriate unit.default Per<CurrentUnit,
LinearAccelerationUnit> div
(LinearAcceleration divisor) Divides this measure by a linear acceleration and returns the result in the most appropriate unit.default Per<CurrentUnit,
LinearMomentumUnit> div
(LinearMomentum divisor) Divides this measure by a linear momentum and returns the result in the most appropriate unit.default Per<CurrentUnit,
LinearVelocityUnit> div
(LinearVelocity divisor) Divides this measure by a linear velocity and returns the result in the most appropriate unit.default Per<CurrentUnit,
MassUnit> Divides this measure by a mass and returns the result in the most appropriate unit.default Per<CurrentUnit,
MomentOfInertiaUnit> div
(MomentOfInertia divisor) Divides this measure by a moment of inertia and returns the result in the most appropriate unit.default Per<CurrentUnit,
MultUnit<?, ?>> Divides this measure by a generic multiplication and returns the result in the most appropriate unit.default Per<CurrentUnit,
PerUnit<?, ?>> Divides this measure by a generic ratio and returns the result in the most appropriate unit.default Per<CurrentUnit,
PowerUnit> Divides this measure by a power and returns the result in the most appropriate unit.default Per<CurrentUnit,
ResistanceUnit> div
(Resistance divisor) Divides this measure by a resistance and returns the result in the most appropriate unit.default Per<CurrentUnit,
TemperatureUnit> div
(Temperature divisor) Divides this measure by a temperature and returns the result in the most appropriate unit.default Velocity<CurrentUnit>
Divides this measure by a time and returns the result in the most appropriate unit.default Per<CurrentUnit,
TorqueUnit> Divides this measure by a torque and returns the result in the most appropriate unit.default Per<CurrentUnit,
VelocityUnit<?>> Divides this measure by a generic velocity and returns the result in the most appropriate unit.default Per<CurrentUnit,
VoltageUnit> Divides this measure by a voltage and returns the result in the most appropriate unit.default Current
divide
(double divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
AccelerationUnit<?>> divide
(Acceleration<?> divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
AngleUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
AngularAccelerationUnit> divide
(AngularAcceleration divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
AngularMomentumUnit> divide
(AngularMomentum divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
AngularVelocityUnit> divide
(AngularVelocity divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Dimensionless
Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Current
divide
(Dimensionless divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
DistanceUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
EnergyUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
ForceUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
FrequencyUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
LinearAccelerationUnit> divide
(LinearAcceleration divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
LinearMomentumUnit> divide
(LinearMomentum divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
LinearVelocityUnit> divide
(LinearVelocity divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
MassUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
MomentOfInertiaUnit> divide
(MomentOfInertia divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
MultUnit<?, ?>> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
PerUnit<?, ?>> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
PowerUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
ResistanceUnit> divide
(Resistance divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
TemperatureUnit> divide
(Temperature divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Velocity<CurrentUnit>
Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
TorqueUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
VelocityUnit<?>> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default Per<CurrentUnit,
VoltageUnit> Deprecated, for removal: This API element is subject to removal in a future version.use div instead.default double
in
(CurrentUnit unit) Converts this measure to a measure with a different unit of the same type, eg minutes to seconds.default Current
minus
(Measure<? extends CurrentUnit> other) Subtracts another measure of the same unit type from this one.default MutCurrent
Returns a mutable copy of this measure.default Current
negate()
Deprecated, for removal: This API element is subject to removal in a future version.use unaryMinus() instead.static Current
ofBaseUnits
(double baseUnitMagnitude, CurrentUnit unit) static Current
ofRelativeUnits
(double magnitude, CurrentUnit unit) default Velocity<CurrentUnit>
Divides this measure by a time period and returns the result in the most appropriate unit.default Current
plus
(Measure<? extends CurrentUnit> other) Adds another measure of the same unit type to this one.default Current
times
(double multiplier) Multiplies this measure by a scalar unitless multiplier.default Mult<CurrentUnit,
AccelerationUnit<?>> times
(Acceleration<?> multiplier) Multiplies this measure by an acceleration and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
AngleUnit> Multiplies this measure by an angle and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
AngularAccelerationUnit> times
(AngularAcceleration multiplier) Multiplies this measure by an angular acceleration and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
AngularMomentumUnit> times
(AngularMomentum multiplier) Multiplies this measure by an angular momentum and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
AngularVelocityUnit> times
(AngularVelocity multiplier) Multiplies this measure by an angular velocity and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
CurrentUnit> Multiplies this measure by an electric current and returns the resulting measure in the most appropriate unit.default Current
times
(Dimensionless multiplier) Multiplies this measure by a scalar dimensionless multiplier.default Mult<CurrentUnit,
DistanceUnit> Multiplies this measure by a distance and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
EnergyUnit> Multiplies this measure by an energy and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
ForceUnit> Multiplies this measure by a force and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
FrequencyUnit> Multiplies this measure by a frequency and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
LinearAccelerationUnit> times
(LinearAcceleration multiplier) Multiplies this measure by a linear acceleration and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
LinearMomentumUnit> times
(LinearMomentum multiplier) Multiplies this measure by a linear momentum and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
LinearVelocityUnit> times
(LinearVelocity multiplier) Multiplies this measure by a linear velocity and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
MassUnit> Multiplies this measure by a mass and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
MomentOfInertiaUnit> times
(MomentOfInertia multiplier) Multiplies this measure by a moment of intertia and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
MultUnit<?, ?>> Multiplies this measure by a generic multiplied measure and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
PerUnit<?, ?>> Multiplies this measure by a generic ratio measurement and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
PowerUnit> Multiplies this measure by a power and returns the resulting measure in the most appropriate unit.default Voltage
times
(Resistance multiplier) Multiplies this measure by a resistance and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
TemperatureUnit> times
(Temperature multiplier) Multiplies this measure by a temperature and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
TimeUnit> Multiplies this measure by a time and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
TorqueUnit> Multiplies this measure by a torque and returns the resulting measure in the most appropriate unit.default Mult<CurrentUnit,
VelocityUnit<?>> Multiplies this measure by a generic velocity and returns the resulting measure in the most appropriate unit.default Power
Multiplies this measure by a voltage and returns the resulting measure in the most appropriate unit.default Current
Returns a measure equivalent to this one equal to zero minus its current value.unit()
Gets the units of this measure.Methods inherited from interface edu.wpi.first.units.Measure
abs, baseUnitMagnitude, compareTo, copySign, div, divide, divideRatio, gt, gte, isEquivalent, isNear, isNear, lt, lte, magnitude, times, timesConversionFactor, timesInverse, timesRatio, toLongString, toShortString
-
Method Details
-
ofRelativeUnits
-
ofBaseUnits
-
copy
Description copied from interface:Measure
Returns an immutable copy of this measure. The copy can be used freely and is guaranteed never to change.- Specified by:
copy
in interfaceMeasure<CurrentUnit>
- Returns:
- the copied measure
-
mutableCopy
Description copied from interface:Measure
Returns a mutable copy of this measure. It will be initialized to the current state of this measure, but can be changed over time without needing to allocate new measurement objects.- Specified by:
mutableCopy
in interfaceMeasure<CurrentUnit>
- Returns:
- the copied measure
-
unit
Description copied from interface:Measure
Gets the units of this measure.- Specified by:
unit
in interfaceMeasure<CurrentUnit>
- Returns:
- the unit
-
baseUnit
Description copied from interface:Measure
A convenience method to get the base unit of the measurement. Equivalent tounit().getBaseUnit()
.- Specified by:
baseUnit
in interfaceMeasure<CurrentUnit>
- Returns:
- the base unit of measure.
-
in
Description copied from interface:Measure
Converts this measure to a measure with a different unit of the same type, eg minutes to seconds. Converting to the same unit is equivalent to callingMeasure.magnitude()
.Meters.of(12).in(Feet) // 39.3701 Seconds.of(15).in(Minutes) // 0.25
- Specified by:
in
in interfaceMeasure<CurrentUnit>
- Parameters:
unit
- the unit to convert this measure to- Returns:
- the value of this measure in the given unit
-
unaryMinus
Description copied from interface:Measure
Returns a measure equivalent to this one equal to zero minus its current value. For non-linear unit types like temperature, the zero point is treated as the zero value of the base unit (eg Kelvin). In effect, this means code likeCelsius.of(10).unaryMinus()
returns a value equivalent to -10 Kelvin, and not -10° Celsius.- Specified by:
unaryMinus
in interfaceMeasure<CurrentUnit>
- Returns:
- a measure equal to zero minus this measure
-
negate
Deprecated, for removal: This API element is subject to removal in a future version.use unaryMinus() instead. This was renamed for consistency with other WPILib classes like Rotation2dReturns a measure equivalent to this one equal to zero minus its current value. For non-linear unit types like temperature, the zero point is treated as the zero value of the base unit (eg Kelvin). In effect, this means code likeCelsius.of(10).negate()
returns a value equivalent to -10 Kelvin, and not -10° Celsius.- Specified by:
negate
in interfaceMeasure<CurrentUnit>
- Returns:
- a measure equal to zero minus this measure
-
plus
Description copied from interface:Measure
Adds another measure of the same unit type to this one.- Specified by:
plus
in interfaceMeasure<CurrentUnit>
- Parameters:
other
- the measurement to add- Returns:
- a measure of the sum of both measures
-
minus
Description copied from interface:Measure
Subtracts another measure of the same unit type from this one.- Specified by:
minus
in interfaceMeasure<CurrentUnit>
- Parameters:
other
- the measurement to subtract- Returns:
- a measure of the difference between the measures
-
times
Description copied from interface:Measure
Multiplies this measure by a scalar unitless multiplier.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the scalar multiplication factor- Returns:
- the scaled result
-
div
Description copied from interface:Measure
Divides this measure by a unitless scalar and returns the result.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a unitless scalar and returns the result.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
per
Description copied from interface:Measure
Divides this measure by a time period and returns the result in the most appropriate unit. This is equivalent todiv(period.of(1))
.- Specified by:
per
in interfaceMeasure<CurrentUnit>
- Parameters:
period
- the time period measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an acceleration and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a generic acceleration and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,AccelerationUnit<?>> divide(Acceleration<?> divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a generic acceleration and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an angle and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an angle and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an angle and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an angular acceleration and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an angular acceleration and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,AngularAccelerationUnit> divide(AngularAcceleration divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an angular acceleration and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an angular momentum and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an angular momentum and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,AngularMomentumUnit> divide(AngularMomentum divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an angular momentum and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an angular velocity and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an angular velocity and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,AngularVelocityUnit> divide(AngularVelocity divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an angular velocity and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an electric current and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an electric current and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an electric current and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
div
Description copied from interface:Measure
Divides this measure by a dimensionless scalar and returns the result.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a dimensionless scalar and returns the result.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a scalar dimensionless multiplier.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the scalar multiplication factor- Returns:
- the scaled result
-
times
Description copied from interface:Measure
Multiplies this measure by a distance and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a distance and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,DistanceUnit> divide(Distance divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a distance and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by an energy and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by an energy and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,EnergyUnit> divide(Energy divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by an energy and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a force and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a force and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a force and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a frequency and returns the resulting measure in the most appropriate unit. This often - but not always - means implementations return a variation of aPer
measure.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a frequency and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,FrequencyUnit> divide(Frequency divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a frequency and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a linear acceleration and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a linear acceleration and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,LinearAccelerationUnit> divide(LinearAcceleration divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a linear acceleration and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a linear momentum and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a linear momentum and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,LinearMomentumUnit> divide(LinearMomentum divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a linear momentum and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a linear velocity and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a linear velocity and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,LinearVelocityUnit> divide(LinearVelocity divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a linear velocity and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a mass and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a mass and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a mass and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a moment of intertia and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a moment of inertia and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,MomentOfInertiaUnit> divide(MomentOfInertia divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a moment of inertia and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a generic multiplied measure and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a generic multiplication and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,MultUnit<?, divide?>> (Mult<?, ?> divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a generic multiplication and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a generic ratio measurement and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a generic ratio and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,PerUnit<?, divide?>> (Per<?, ?> divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a generic ratio and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a power and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a power and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a power and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a resistance and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a resistance and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,ResistanceUnit> divide(Resistance divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a resistance and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a temperature and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a temperature and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,TemperatureUnit> divide(Temperature divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a temperature and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a time and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a time and returns the result in the most appropriate unit. This will often - but not always - result in aPer
type likeLinearVelocity
orAcceleration
.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a time and returns the result in the most appropriate unit. This will often - but not always - result in aPer
type likeLinearVelocity
orAcceleration
.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a torque and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a torque and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,TorqueUnit> divide(Torque divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a torque and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a generic velocity and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a generic velocity and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,VelocityUnit<?>> divide(Velocity<?> divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a generic velocity and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
times
Description copied from interface:Measure
Multiplies this measure by a voltage and returns the resulting measure in the most appropriate unit.- Specified by:
times
in interfaceMeasure<CurrentUnit>
- Parameters:
multiplier
- the measurement to multiply by.- Returns:
- the multiplication result
-
div
Description copied from interface:Measure
Divides this measure by a voltage and returns the result in the most appropriate unit.- Specified by:
div
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-
divide
@Deprecated(since="2025", forRemoval=true) default Per<CurrentUnit,VoltageUnit> divide(Voltage divisor) Deprecated, for removal: This API element is subject to removal in a future version.use div instead. This was renamed for consistency with other languages like KotlinDivides this measure by a voltage and returns the result in the most appropriate unit.- Specified by:
divide
in interfaceMeasure<CurrentUnit>
- Parameters:
divisor
- the measurement to divide by.- Returns:
- the division result
-