|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectvisad.Unit
visad.ScaledUnit
public final class ScaledUnit
A class that represents a certain amount of a derived unit.
Constructor Summary | |
---|---|
ScaledUnit(double amount)
Construct a dimensionless scaled unit. |
|
ScaledUnit(double amount,
BaseUnit that)
Construct a scaled unit from a base unit. |
|
ScaledUnit(double amount,
BaseUnit that,
java.lang.String identifier)
Construct a scaled unit from a base unit and an identifier. |
|
ScaledUnit(double amount,
DerivedUnit that)
Construct a scaled unit from a derived unit. |
|
ScaledUnit(double amount,
DerivedUnit that,
java.lang.String identifier)
Construct a scaled unit from a derived unit and an identifier. |
|
ScaledUnit(double amount,
ScaledUnit unit)
Construct a scaled unit from a scaled unit. |
|
ScaledUnit(double amount,
ScaledUnit that,
java.lang.String identifier)
Construct a scaled unit from a scaled unit and an identifier. |
|
ScaledUnit(double amount,
java.lang.String identifier)
Construct a dimensionless scaled unit with an identifier. |
Method Summary | |
---|---|
static ScaledUnit |
create(double amount,
Unit unit)
Factory method for creating a scaled unit. |
Unit |
divide(Unit that)
Divides this unit by another unit. |
protected Unit |
divideInto(Unit that)
Divides this unit into another unit. |
boolean |
equals(Unit unit)
Indicates if this instance is equal to a unit. |
java.lang.String |
getDefinition()
Returns 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(Unit that)
Multiplies this unit by another unit. |
Unit |
pow(double power)
Raises this unit to a power. |
Unit |
pow(int power)
Raises this 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. |
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, scale, shift, 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 ScaledUnit(double amount)
amount
- The given amount of this unit.public ScaledUnit(double amount, java.lang.String identifier)
amount
- The given amount of this unit.identifier
- Name or abbreviation for the unit. May be
null
or empty.public ScaledUnit(double amount, BaseUnit that)
null
.
amount
- The given amount of the base unit (e.g. 0.9144 to
create a yard unit if unit
represents a
meter).that
- The given base unit.public ScaledUnit(double amount, BaseUnit that, java.lang.String identifier)
amount
- The given amount of the base unit (e.g. 0.9144
to create a yard unit if unit
represents a meter).that
- The given base unit.identifier
- Name or abbreviation for the unit. May be
null
or empty.public ScaledUnit(double amount, DerivedUnit that)
null
.
amount
- The given amount of the derived unit (e.g. 0.44704 to
create a mile/hour unit if unit
represents
a meter/second.that
- The given derived unit.public ScaledUnit(double amount, DerivedUnit that, java.lang.String identifier)
amount
- The given amount of the derived unit
(e.g. 0.44704 to create a mile/hour unit if
unit
represents a meter/second.that
- The given derived unit.identifier
- Name or abbreviation for the unit. May be
null
or empty.public ScaledUnit(double amount, ScaledUnit unit)
null
.
amount
- The given amount of the scaled unit (e.g. 3.0 to
create a yard unit if unit
represents
a foot.unit
- The given scaled unit.public ScaledUnit(double amount, ScaledUnit that, java.lang.String identifier)
amount
- The given amount of the scaled unit (e.g. 3.0
to create a yard unit if unit
represents a foot.that
- The given scaled unit.identifier
- Name or abbreviation for the unit. May be
null
or empty.Method Detail |
---|
public static ScaledUnit create(double amount, Unit unit) throws UnitException
null
.
amount
- The given amount of the scaled unit (e.g. 3.0 to
create a yard unit if unit
represents
a foot.unit
- The given unit.
UnitException
- Can't create Scaled Unit from unit
.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
- The root value is zero or the resulting unit 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 integral.
power
.
java.lang.IllegalArgumentException
- This unit is not dimensionless and power
has a non-integral value.public java.lang.String getDefinition()
getDefinition
in class Unit
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 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 static void main(java.lang.String[] args) throws UnitException
args
- Arguments (ignored).
UnitException
- A problem occurred.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 |