|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.me.nxg.unity.OneUnit
public class OneUnit
A single unit. This is represented as a prefix, a base unit and an exponent. For example, the string "mm s^-2" will result in two OneUnit instances, one of which will have a base unit of "m" and a prefix power of -3, and the other of which will have a base unit of "s" and an exponent of -2.
This represents the abstract unit, shorn of the symbols which were parsed to obtain it. Thus if, in some odd syntax, the symbol 'x' were used to denote metres, then the OneUnit instance which resulted would be the same as the OneUnit which resulted from a more conventional syntax.
Also, there is a potential ambiguity if a symbol is recognised
in one syntax, but not in another. Thus if the string 'erg' were
parsed in a syntax which didn't recognise that, then it would be
stored as just that, an unrecognised symbol, not associated with
the UnitDefinition
for the erg.
The class's instances are immutable.
Method Summary | |
---|---|
boolean |
equals(Object o)
Two units are equal if they have the same power, units and exponent. |
UnitDefinition |
getBaseUnitDefinition()
Returns the known base unit. |
String |
getBaseUnitName()
Returns the name of this unit. |
Dimensions |
getDimensions()
Return the dimensions of the unit, if it is a recognised one. |
double |
getExponent()
Obtains the power the unit is raised to. |
double |
getPower()
Returns the power to which this unit is raised. |
int |
getPrefix()
Returns the prefix of the unit, as a base-ten log. |
int |
hashCode()
|
boolean |
isRecognisedUnit(String syntax)
Indicates whether the base unit is one of those recognised within the specification of the given syntax. |
boolean |
isRecommendedUnit(String syntax)
Indicates whether the base unit is one of those recommended within the specification of the given syntax. |
boolean |
satisfiesUsageConstraints(String syntax)
Indicates whether the unit is being used in a way which satisfies any usage constraints. |
String |
toDebugString()
Write out the unit in a testable format. |
String |
toString()
Format this unit in some sort of canonical form. |
String |
unitString()
Obtains the string form of the unit, including prefix, with a default syntax. |
String |
unitString(String syntaxName)
Obtains the string representation of the unit, including prefix, in the given syntax. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int getPrefix()
public double getPower()
public String toString()
UnitExpr.toString()
.
toString
in class Object
public String unitString(String syntaxName) throws UnitParserException
syntaxName
- one of the syntaxes of UnitParser
UnitParserException
- if the syntax is unrecognisedpublic UnitDefinition getBaseUnitDefinition()
getBaseUnitString()
will not.
Note that the 'base unit' is simply the unit without the prefix, and doesn't refer to the fundamental SI base units. Thus in the expression "MW", it is 'W', Watt, that is the base unit.
public String getBaseUnitName()
public Dimensions getDimensions()
public String unitString()
The default syntax is (currently) the syntax with which this unit was originally read.
public double getExponent()
public boolean isRecognisedUnit(String syntax)
Note that this checks that the unit is a recommended one: we don't (currently) check whether the abbreviation that got us here is a recommended one (for example, "pixel" is a valid FITS/CDS name for pixels, and "pix" is a FITS and OGIP one).
syntax
- one of the syntaxes of UnitParser
isRecommendedUnit(java.lang.String)
public boolean isRecommendedUnit(String syntax)
Note that this checks that the unit is a recommended one: we don't (currently) check whether the abbreviation that got us here is a recommended one (for example, "pixel" is a valid FITS/CDS name for pixels, and "pix" is a FITS and OGIP one).
syntax
- one of the syntaxes of UnitParser
isRecognisedUnit(java.lang.String)
public boolean satisfiesUsageConstraints(String syntax)
An unrecognised unit has no constraints, and so will always satisfy them; this extends to units which are unrecognised in a particular syntax.
syntax
- one of the syntaxes of UnitParser
public String toDebugString()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |