|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xspace.mx.physics.mutable.BaseUnit
org.xspace.mx.physics.mutable.Immutable
An immutable wrapper for any other unit.
Field Summary |
Fields inherited from class org.xspace.mx.physics.mutable.BaseUnit |
DIM_ANGLE, DIM_LENGTH, DIM_MASS, DIM_TIME, dims, systemValue, TOL |
Constructor Summary | |
Immutable(Measurement protectThis)
Creates a new instance of Immutable |
Method Summary | |
Measurement |
copy()
Returns a new instance of a Measurement that is "equivalent" in value to this Measurement. |
Measurement |
div(double scaling)
Divides this Measurement by a scalar value. |
Measurement |
div(Measurement other)
Divides this Measurement by the other Measurement. |
java.lang.String |
getAbbr()
An abbreviated description of the units of this Measurement |
java.lang.String |
getDescription()
A description of the units of this Measurement |
SystemOfUnits |
getSystem()
The system of units being used by this Measurement. |
Unit[] |
getSystemDimensions()
An array of Unit s within the SystemOfUnits being used by this Measurement. |
double |
getSystemValue()
The internal value of this measurement. |
double |
getValue(Measurement multipleOf)
The value of this measurement relative to the dimensions of the input measurement. |
Measurement |
minus(Measurement other)
Subtracts the other Measurement to this Measurement. |
Measurement |
mult(double scaling)
Multiplies this Measurement by a scalar value. |
Measurement |
mult(Measurement other)
Multiplies the other Measurement to this Measurement. |
Measurement |
plus(Measurement other)
Adds the other Measurement to this Measurement. |
Measurement |
pow(double power)
Raises this Measurement to the specified power. |
Measurement |
root(double power)
Tales the root this Measurement by the specified power. |
java.lang.String |
toString()
A description of the measurement |
Methods inherited from class org.xspace.mx.physics.mutable.BaseUnit |
isSameMeasurementType |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Immutable(Measurement protectThis)
protectThis
- The other Measurement that will be protected.Method Detail |
public Measurement copy()
Measurement
copy
in interface Measurement
copy
in class BaseUnit
public Measurement div(double scaling)
Measurement
Divides this Measurement
by a scalar value. This does not affect the Unit
s of the Measurement.
Depending on the implementation, this may or may not alter this object.
For example, if the Measurement represents five meters per second (5 [m / s]), and it is divided by 2, then the result will be two-and-a-half meters per second (2.5 [m / s]).
div
in interface Measurement
div
in class BaseUnit
public Measurement div(Measurement other)
Measurement
Divides this Measurement by the other Measurement.
Depending on the implementation, this may or may not alter this object.
div
in interface Measurement
div
in class BaseUnit
public java.lang.String getAbbr()
Measurement
getAbbr
in interface Measurement
getAbbr
in class BaseUnit
public java.lang.String getDescription()
Measurement
getDescription
in interface Measurement
getDescription
in class BaseUnit
public SystemOfUnits getSystem()
Measurement
The system of units being used by this Measurement.
Knowledge of SystemOfUnits
being used is vital for proper implementations of
any of the arithmetic methods: Measurement.plus(Measurement)
, Measurement.minus(Measurement)
, Measurement.mult(Measurement)
, Measurement.div(Measurement)
.
Both Measurements must reference the same SystemOfUnits for a proper comparison.
For example, if Person A weighs items in terms of kilograms, and Person B weighs items in terms of pounds, then they must both agree on a common system of units before they can properly compare weights. Their decision could be to measure items using the SI system of units, Imperial system of units, or perhaps some other one.
getSystem
in interface Measurement
getSystem
in class BaseUnit
public Unit[] getSystemDimensions()
Measurement
An array of Unit
s within the SystemOfUnits
being used by this Measurement.
This array of Dimensions is vital for proper implementations of
any of the arithmetic methods: Measurement.plus(Measurement)
, Measurement.minus(Measurement)
, Measurement.mult(Measurement)
, Measurement.div(Measurement)
,
Measurement.pow(double)
, Measurement.root(double)
.
For example, if this Measurement measures the speed of five meters per second, then this method would return an array of Dimensions that contains:
getSystemDimensions
in interface Measurement
getSystemDimensions
in class BaseUnit
public double getSystemValue()
Measurement
The internal value of this measurement. Meant to be used in the implementations of the other methods.
For example, an implementation might store the value of the measurement
as a multiple of the "standard units" of the SystemOfUnits
being used.
getSystemValue
in interface Measurement
getSystemValue
in class BaseUnit
public double getValue(Measurement multipleOf)
Measurement
getValue
in interface Measurement
getValue
in class BaseUnit
public Measurement minus(Measurement other) throws MeasurementException
Measurement
Subtracts the other Measurement to this Measurement.
Depending on the implementation, this may or may not alter this object.
minus
in interface Measurement
minus
in class BaseUnit
MeasurementException
public Measurement mult(double scaling)
Measurement
Multiplies this Measurement
by a scalar value. This does not affect the Unit
s of the Measurement.
Depending on the implementation, this may or may not alter this object.
For example, if the Measurement represents five meters per second (5 [m / s]), and it is multiplied by 2, then the result will be ten meters per second (10 [m / s]).
mult
in interface Measurement
mult
in class BaseUnit
public Measurement mult(Measurement other)
Measurement
Multiplies the other Measurement to this Measurement.
Depending on the implementation, this may or may not alter this object.
mult
in interface Measurement
mult
in class BaseUnit
public Measurement plus(Measurement other) throws MeasurementException
Measurement
Adds the other Measurement to this Measurement.
Depending on the implementation, this may or may not alter this object.
plus
in interface Measurement
plus
in class BaseUnit
MeasurementException
public Measurement pow(double power)
Measurement
Raises this Measurement
to the specified power.
Depending on the implementation, this may or may not alter this object.
For example, if the Measurement represents five meters per second (5 [m / s]), and it is raised to the power of two, the result will be twenty-five meters squared per second squared (25 [m^2 / s^2]).
pow
in interface Measurement
pow
in class BaseUnit
public Measurement root(double power)
Measurement
Tales the root this Measurement
by the specified power.
Depending on the implementation, this may or may not alter this object.
For example, if the Measurement represents nine square meters (9 [m^2]), and the square root is taken (power = 2), the result will be three meters (3 [m]).
root
in interface Measurement
root
in class BaseUnit
public java.lang.String toString()
BaseUnit
toString
in class BaseUnit
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |