jahuwaldt.js.unit

Class UnitSet

java.lang.Object

jahuwaldt.js.unit.UnitSet

All Implemented Interfaces:

java.lang.Cloneable

public final class UnitSet
extends java.lang.Object
implements java.lang.Cloneable

A class that contains a set of units (generally made self-consistent if not coherent) and also provides lists (sets) of related units.

Modified by: Joseph A. Huwaldt

Version:

March 19, 2017

Author:

Joseph A. Huwaldt, Date: July 12, 2008

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitSet.SetType The different unit set types in this collection.
static class	UnitSet.UnitSystem The type of unit system being used.

Field Summary

Fields

Modifier and Type	Field and Description
static Unit	DEG The angular unit "degree".
static Unit	RAD The angular unit "radian".

Constructor Summary

Constructors

Constructor and Description
UnitSet(UnitSet.UnitSystem system) Construct a coherent set of units based on the system identification provided.

Method Summary

Modifier and Type	Method and Description
Unit<Acceleration>	acceleration() Return the acceleration units.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l)
Unit<Angle>	angle() Return the angular measure units for this unit set.
Unit<AngularVelocity>	angularVelocity() Return the angular velocity units.
Unit<Area>	area() Return the area units.
void	clearPropertyChangeListeners()
java.lang.Object	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj) Compares this UnitSet against the specified object for strict equality.
Unit<Force>	force() Return the force units.
static Unit[]	getSet(UnitSet.SetType type) Returns an array of units of the specified type (array of related units).
UnitSet.UnitSystem	getSystem() Method that returns the Unit System for this unit set.
int	hashCode() Returns the hash code for this UnitSet.
Unit<Inertia>	inertia() Return the inertia units.
boolean	isCoherent() Return true if this unit set is coherent.
boolean	isConsistent() Return true if this unit set is consistent.
Unit<Length>	length() Return the length units for this unit set.
void	makeConsistent() Makes this unit set consistent by deriving a complete set of units for this application based on the fundamental or base units of time, length, mass and angle.
Unit<Mass>	mass() Return the mass units for this unit set.
Unit<VolumetricDensity>	massDensity() Return the mass density units.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l)
void	setAngle(Unit<Angle> unit) Method used to set the angular measure units in this unit set.
void	setLength(Unit<Length> unit) Method used to set the length units in this unit set.
void	setMass(Unit<Mass> unit) Method used to set the mass units in this unit set.
void	setTime(Unit<Duration> unit) Method used to set the time units in this unit set.
Unit<Duration>	time() Return the duration of time units for this unit set.
Unit<Torque>	torque() Return the torque units.
Unit<Velocity>	velocity() Return the velocity units.
Unit<Volume>	volume() Return the volume units.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEG

public static final Unit DEG

The angular unit "degree".

RAD

public static final Unit RAD

The angular unit "radian".

Constructor Detail

UnitSet

public UnitSet(UnitSet.UnitSystem system)

Construct a coherent set of units based on the system identification provided.

Parameters:

system - The Unit System type.

Method Detail

getSystem

public UnitSet.UnitSystem getSystem()

Method that returns the Unit System for this unit set.

Returns:

The UnitSystem for this unit set.

getSet

public static Unit[] getSet(UnitSet.SetType type)

Returns an array of units of the specified type (array of related units).

Parameters:

type - The unit type to return an array of units for.

Returns:

The unit set array requested

isCoherent

public boolean isCoherent()

Return true if this unit set is coherent. Coherent means that the derived units in this set are a product of powers of base units with no other proportionality factor than one.

Returns:

true if this unit set is coherent.

See Also:

isConsistent()

isConsistent

public boolean isConsistent()

Return true if this unit set is consistent. Consistent means that the derived units are made up of powers of the base units though there may be conversion factors involved.

Returns:

true if this unit set is consistent.

See Also:

makeConsistent(), isCoherent()

makeConsistent

public void makeConsistent()

Makes this unit set consistent by deriving a complete set of units for this application based on the fundamental or base units of time, length, mass and angle. Consistent means that the derived units in this set are all derived from the base units.

See Also:

isConsistent(), isCoherent()

time

public Unit<Duration> time()

Return the duration of time units for this unit set.

Returns:

The units of durations of time.

setTime

public void setTime(Unit<Duration> unit)
             throws ConversionException

Method used to set the time units in this unit set. All units that have a time/duration component will be changed to use this time value after a call to "makeCoherent()".

Parameters:

unit - the time unit to set this unit set to.

Throws:

ConversionException - if the provided unit is not compatible with time (seconds).

See Also:

makeConsistent()

length

public Unit<Length> length()

Return the length units for this unit set.

Returns:

The length units.

setLength

public void setLength(Unit<Length> unit)
               throws ConversionException

Method used to set the length units in this unit set. All units that have a length component will be changed to use this length value after a call to "makeCoherent()".

Parameters:

unit - the length unit to set this unit set to.

Throws:

ConversionException - if the provided unit is not compatible with length (meters).

See Also:

makeConsistent()

mass

public Unit<Mass> mass()

Return the mass units for this unit set.

Returns:

The mass units.

setMass

public void setMass(Unit<Mass> unit)
             throws ConversionException

Method used to set the mass units in this unit set. All units that have a mass component will be changed to use this mass value after a call to "makeCoherent()".

Parameters:

unit - the mass unit to set this unit set to.

Throws:

ConversionException - if the provided unit is not compatible with mass (kg).

See Also:

makeConsistent()

angle

public Unit<Angle> angle()

Return the angular measure units for this unit set.

Returns:

The angular measure units.

setAngle

public void setAngle(Unit<Angle> unit)
              throws ConversionException

Method used to set the angular measure units in this unit set. All units that have an angular measure component will be changed to use this value after a call to "makeCoherent()".

Parameters:

unit - the angle unit to set this unit set to.

Throws:

ConversionException - if the provided unit is not compatible with angles (radian).

See Also:

makeConsistent()

area

public Unit<Area> area()

Return the area units.

Returns:

Area units

volume

public Unit<Volume> volume()

Return the volume units.

Returns:

Volume units

velocity

public Unit<Velocity> velocity()

Return the velocity units.

Returns:

Velocity units

acceleration

public Unit<Acceleration> acceleration()

Return the acceleration units.

Returns:

Acceleration units

force

public Unit<Force> force()

Return the force units.

Returns:

Force units

inertia

public Unit<Inertia> inertia()

Return the inertia units.

Returns:

Inertia units

massDensity

public Unit<VolumetricDensity> massDensity()

Return the mass density units.

Returns:

Mass density units.

angularVelocity

public Unit<AngularVelocity> angularVelocity()

Return the angular velocity units.

Returns:

Angular velocity units.

torque

public Unit<Torque> torque()

Return the torque units.

Returns:

The torque units.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A clone of this UnitSet.

equals

public boolean equals(java.lang.Object obj)

Compares this UnitSet against the specified object for strict equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare with.

Returns:

true if this UnitSet is identical to that object; false otherwise.

hashCode

public int hashCode()

Returns the hash code for this UnitSet.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener l)

clearPropertyChangeListeners

public void clearPropertyChangeListeners()