Package org.parts3492.partslib

Class PARTsUnit

java.lang.Object

org.parts3492.partslib.PARTsUnit

public class PARTsUnit
extends Object

PARTsUnit - A unit container to store and convert values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PARTsUnit.PARTsUnitType

Field Summary

Fields

Modifier and Type	Field	Description
static Function<Double,Double>	DegreesToRadians
static Function<Double,Double>	InchesToMeters
static Function<Double,Double>	MetersToInches

Constructor Summary

Constructors

Constructor	Description
PARTsUnit(double value, PARTsUnit.PARTsUnitType unitType)	Create a new PARTsUnit.

Method Summary

Modifier and Type	Method	Description
PARTsUnit	as(PARTsUnit.PARTsUnitType unitType)	Converts current unit into the requested unit.
double	getMagnitude()	Gets the absolute value as a double.
PARTsUnit.PARTsUnitType	getUnitType()	Get the current unit type for an instance of PARTsUnit.
double	getValue()	Gets the raw value as a double.
double	to(PARTsUnit.PARTsUnitType unitType)	Converts current unit into the requested unit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

InchesToMeters

public static Function<Double,Double> InchesToMeters

MetersToInches

public static Function<Double,Double> MetersToInches

DegreesToRadians

public static Function<Double,Double> DegreesToRadians

Constructor Details

PARTsUnit

public PARTsUnit(double value,
 PARTsUnit.PARTsUnitType unitType)

Create a new PARTsUnit.

Parameters:

value - The initial value of the unit.

unitType - The type that the initial value is currently in.

Method Details

getValue

public double getValue()

Gets the raw value as a double.

Returns:

The value as a double.

getMagnitude

public double getMagnitude()

Gets the absolute value as a double.

Returns:

The value as a double.

getUnitType

public PARTsUnit.PARTsUnitType getUnitType()

Get the current unit type for an instance of PARTsUnit.

Returns:

The unit type as a PARTsUnitType.

to

public double to(PARTsUnit.PARTsUnitType unitType)

Converts current unit into the requested unit.

Parameters:

unitType - The target unit.

Returns:

Converted unit in double.

as

public PARTsUnit as(PARTsUnit.PARTsUnitType unitType)

Converts current unit into the requested unit.

Parameters:

unitType - The target PARTsUnitType.

Returns:

The converted PARTsUnit.