Package edu.wpi.first.units.measure

Record Class ImmutablePer<Dividend extends Unit,Divisor extends Unit>

java.lang.Object

java.lang.Record

edu.wpi.first.units.measure.ImmutablePer<Dividend,Divisor>

All Implemented Interfaces:

Measure<PerUnit<Dividend,Divisor>>, Per<Dividend,Divisor>, Comparable<Measure<PerUnit<Dividend,Divisor>>>

public record ImmutablePer<Dividend extends Unit,Divisor extends Unit>(double magnitude, double baseUnitMagnitude, PerUnit<Dividend extends Unit,Divisor extends Unit> unit)
extends Record
implements Per<Dividend,Divisor>

Field Summary

Fields inherited from interface edu.wpi.first.units.Measure

EQUIVALENCE_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
ImmutablePer(double magnitude, double baseUnitMagnitude, PerUnit<Dividend,Divisor> unit)	Creates an instance of a ImmutablePer record class.

Method Summary

Modifier and Type	Method	Description
double	baseUnitMagnitude()	Returns the value of the baseUnitMagnitude record component.
Per<Dividend,Divisor>	copy()	Returns an immutable copy of this measure.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
double	magnitude()	Returns the value of the magnitude record component.
String	toString()	Returns a string representation of this record class.
PerUnit<Dividend,Divisor>	unit()	Returns the value of the unit record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.wpi.first.units.Measure

abs, compareTo, copySign, div, divide, divideRatio, gt, gte, isEquivalent, isNear, isNear, lt, lte, times, timesConversionFactor, timesInverse, timesRatio, toLongString, toShortString

Methods inherited from interface edu.wpi.first.units.measure.Per

baseUnit, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, div, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, divide, in, minus, mutableCopy, negate, per, plus, reciprocal, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, times, timesDivisor, unaryMinus

Constructor Details

ImmutablePer

public ImmutablePer(double magnitude,
 double baseUnitMagnitude,
 PerUnit<Dividend,Divisor> unit)

Creates an instance of a ImmutablePer record class.

Parameters:

magnitude - the value for the magnitude record component

baseUnitMagnitude - the value for the baseUnitMagnitude record component

unit - the value for the unit record component

Method Details

copy

public Per<Dividend,Divisor> 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 interface Measure<Dividend extends Unit>

Specified by:

copy in interface Per<Dividend extends Unit,Divisor extends Unit>

Returns:

the copied measure

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

magnitude

public double magnitude()

Returns the value of the magnitude record component.

Specified by:

magnitude in interface Measure<Dividend extends Unit>

Returns:

the value of the magnitude record component

baseUnitMagnitude

public double baseUnitMagnitude()

Returns the value of the baseUnitMagnitude record component.

Specified by:

baseUnitMagnitude in interface Measure<Dividend extends Unit>

Returns:

the value of the baseUnitMagnitude record component

unit

public PerUnit<Dividend,Divisor> unit()

Returns the value of the unit record component.

Specified by:

unit in interface Measure<Dividend extends Unit>

Specified by:

unit in interface Per<Dividend extends Unit,Divisor extends Unit>

Returns:

the value of the unit record component