|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectvisad.Unit
visad.DerivedUnit
public final class DerivedUnit
A class that represents a unit consisting of zero or more base units.
Constructor Summary | |
---|---|
DerivedUnit()
Construct a dimensionless derived unit. |
|
DerivedUnit(BaseUnit baseUnit)
Construct a derived unit from a base unit. |
|
DerivedUnit(BaseUnit[] baseUnits,
int[] powers)
Construct a derived unit from an array base units and powers. |
|
DerivedUnit(BaseUnit[] baseUnits,
int[] powers,
java.lang.String identifier)
Construct a derived unit from an array base units, powers, and an identifier. |
|
DerivedUnit(DerivedUnit that,
java.lang.String identifier)
Construct a derived unit from a derived unit and an identifier. |
|
DerivedUnit(java.lang.String identifier)
Construct a dimensionless derived unit with an identifier. |
Method Summary | |
---|---|
Unit |
divide(Unit that)
Divide a derived unit by another unit. |
protected Unit |
divideInto(Unit that)
Divide a derived unit into another unit. |
boolean |
equals(Unit unit)
Indicates if this instance equals a unit. |
java.lang.String |
getDefinition()
Return the definition of this unit. |
boolean |
isConvertible(Unit unit)
Indicate whether this unit is convertible with another unit. |
boolean |
isDimensionless()
Indicates if this instance is dimensionless. |
static void |
main(java.lang.String[] args)
Test this class. |
Unit |
multiply(DerivedUnit that)
Multiply a derived unit by a derived unit. |
Unit |
multiply(Unit that)
Multiply a derived unit by another unit. |
protected static visad.Factor[] |
newFactors(BaseUnit[] baseUnits,
int[] powers)
Creates an array of Factor-s from arrays of base units and powers. |
Unit |
pow(double power)
Raise a derived unit to a power. |
Unit |
pow(int power)
Raise a derived unit to a power. |
protected Unit |
protectedClone(java.lang.String identifier)
Clones this unit, changing the identifier. |
Unit |
root(int root)
Returns the N-th root of this unit. |
Unit |
scale(double amount)
Scale this unit by an amount. |
Unit |
shift(double offset)
Shift this unit by an amount. |
double[] |
toThat(double[] values,
Unit that)
Convert values from this unit to another unit. |
float[] |
toThat(float[] values,
Unit that)
Convert values from this unit to another unit. |
double[] |
toThis(double[] values,
Unit that)
Convert values to this unit from another unit. |
float[] |
toThis(float[] values,
Unit that)
Convert values to this unit from another unit. |
Methods inherited from class visad.Unit |
---|
adjustCheckAndCache, canConvert, canConvertArray, clone, convertTuple, convertTuple, copyUnitsArray, getAbsoluteUnit, getIdentifier, sqrt, toString, toThat, toThis, transformUnits, transformUnits |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DerivedUnit()
public DerivedUnit(java.lang.String identifier)
identifier
- Name or abbreviation for the unit. May be
null
or empty.public DerivedUnit(BaseUnit baseUnit)
baseUnit
- The base unit.public DerivedUnit(BaseUnit[] baseUnits, int[] powers)
null
.
baseUnits
- The array of base units (e.g. {m, s}).powers
- The array of powers (e.g. {1, -1} to create a
m/s unit).public DerivedUnit(BaseUnit[] baseUnits, int[] powers, java.lang.String identifier)
baseUnits
- The array of base units (e.g. {m, s}).powers
- The array of powers (e.g. {1, -1} to create a
m/s unit).identifier
- Name or abbreviation for the unit. May be
null
or empty.public DerivedUnit(DerivedUnit that, java.lang.String identifier)
that
- The derived unit.identifier
- Name or abbreviation for the unit. May be
null
or empty.Method Detail |
---|
protected static visad.Factor[] newFactors(BaseUnit[] baseUnits, int[] powers)
baseUnits
- The array of base units (e.g. {m, s}).powers
- The array of powers (e.g. {1, -1} to create a
m/s unit).
Factor
s equivalent to the
given base units and powers.public boolean isDimensionless()
Indicates if this instance is dimensionless. A unit is dimensionless if it is a measure of a dimensionless quantity like angle or concentration. Examples of dimensionless units include radian, degree, steradian, and "g/kg".
isDimensionless
in class Unit
protected Unit protectedClone(java.lang.String identifier)
protectedClone
in class Unit
identifier
- The name or abbreviation for the cloned unit.
May be null
or empty.
public Unit pow(int power)
pow
in class Unit
power
- The power to raise this unit by.
power
.public Unit root(int root) throws java.lang.IllegalArgumentException
root
in class Unit
root
- The root to take (e.g. 2 means square root). May not
be zero.
root
-th root
of this unit.
java.lang.IllegalArgumentException
- root
is zero or the result would have a
non-integral unit dimension.public Unit pow(double power) throws java.lang.IllegalArgumentException
pow
in class Unit
power
- The power to raise this unit by. If this unit
is not dimensionless, then the value must be
an integer or the reciprocal of an integer.
power
.
java.lang.IllegalArgumentException
- This unit is not dimensionless and power
is neither an integer nor the
reciprocal of an integer.public Unit scale(double amount) throws UnitException
scale
in class Unit
amount
- The amount by which to scale this unit. E.g.
Unit yard = meter.scale(0.9144);
UnitException
- This unit cannot be scaled.public Unit shift(double offset) throws UnitException
shift
in class Unit
offset
- The amount by which to shift this unit. E.g.
Unit celsius = kelvin.shift(273.15);
UnitException
- The unit subclass is unknown.public java.lang.String getDefinition()
getDefinition
in class Unit
public static void main(java.lang.String[] args) throws UnitException
args
- Arguments (ignored).
UnitException
- A problem occurred.public Unit multiply(Unit that) throws UnitException
multiply
in class Unit
that
- The unit with which to multiply this unit.
UnitException
- Meaningless operation.public Unit multiply(DerivedUnit that)
that
- The derived unit with which to multiply this unit.
public Unit divide(Unit that) throws UnitException
divide
in class Unit
that
- The unit to divide into this unit.
UnitException
- Meaningless operation.protected Unit divideInto(Unit that) throws UnitException
divideInto
in class Unit
that
- The unit to be divided by this unit.
UnitException
- Meaningless operation.public double[] toThis(double[] values, Unit that) throws UnitException
toThis
in class Unit
values
- The values to be converted.that
- The unit of values
.
UnitException
- The units are not convertible.public float[] toThis(float[] values, Unit that) throws UnitException
toThis
in class Unit
values
- The values to be converted.that
- The unit of values
.
UnitException
- The units are not convertible.public double[] toThat(double[] values, Unit that) throws UnitException
toThat
in class Unit
values
- The values to be converted in units of this unit.that
- The unit to which to convert the values.
UnitException
- The units are not convertible.public float[] toThat(float[] values, Unit that) throws UnitException
toThat
in class Unit
values
- The values to be converted in units of this unit.that
- The unit to which to convert the values.
UnitException
- The units are not convertible.public boolean isConvertible(Unit unit)
toThis(...)
/ and
toThat(...)
methods will not throw a UnitException. Unit A
is convertible with unit B if and only if unit B is convertible with unit
A; hence, calling-order is irrelevant.
isConvertible
in class Unit
unit
- The other unit.
public boolean equals(Unit unit)
equals
in class Unit
unit
- The unit.
true
if and only if this instance
equals the unit.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |