|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.me.nxg.unity.OneUnit
uk.me.nxg.unity.FunctionOfUnit
public class FunctionOfUnit
Represents a function of a unit, such as log(m)
. This consists of a function ('log'
in this case) and an operand ('m' in this case). The interpretation of log(m)
is
that it represents the log of the dimensionless number obtained by dividing a quantity (which
presumably has the dimensions of length) by the quantity 1 m.
The functions getBaseUnitName()
,
getBaseUnitDefinition()
, and getBaseUnitString()
, apply to the
operand. In particular, they give the information about the first
unit in the function operand, even if it has multiple units (such
as log(V^2/mm)
. This isn't ideal, but it's probably
roughly what is wanted in the majority of cases where this function
is used.
The functions isRecognisedUnit(java.lang.String)
and isRecommendedUnit(java.lang.String)
are true if they
would be true when applied to the operand and the function is a recognised in this
syntax; there are no usage constraints on functions, so the function
satisfiesUsageConstraints(java.lang.String)
is true if it would be true when applied to the operand.
Method Summary | |
---|---|
UnitDefinition |
getBaseUnitDefinition()
Returns the known base unit. |
String |
getBaseUnitName()
Returns the name of this unit. |
String |
getBaseUnitString()
Returns the base unit string, which will only be non-null if this unit was an unrecognised one. |
Dimensions |
getDimensions()
Return the dimensions of the unit, if it is a recognised one. |
FunctionDefinition |
getFunctionDefinition()
The function which is applied to the operand. |
String |
getFunctionName()
The function which is applied to the operand. |
int |
getPrefix()
Returns the prefix of the unit, as a base-ten log. |
OneUnit |
getUnit(UnitDefinition reqUnit)
Returns the unit in the operand which corresponds to the required unit. |
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 |
toString(String syntax)
Format this unit in some sort of canonical form appropriate to the given syntax. |
String |
unitString(String syntaxName)
Obtains the string representation of the unit, including prefix, in the given syntax. |
Methods inherited from class uk.me.nxg.unity.OneUnit |
---|
getExponent |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public int getPrefix()
OneUnit
getPrefix
in class OneUnit
public Dimensions getDimensions()
OneUnit
getDimensions
in class OneUnit
public UnitDefinition getBaseUnitDefinition()
OneUnit
OneUnit.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.
getBaseUnitDefinition
in class OneUnit
public String getBaseUnitName()
OneUnit
getBaseUnitName
in class OneUnit
public String getBaseUnitString()
OneUnit
getBaseUnitString
in class OneUnit
public OneUnit getUnit(UnitDefinition reqUnit)
public boolean isRecognisedUnit(String syntax)
OneUnit
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).
isRecognisedUnit
in class OneUnit
syntax
- one of the syntaxes of UnitParser
OneUnit.isRecommendedUnit(java.lang.String)
public boolean isRecommendedUnit(String syntax)
OneUnit
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).
isRecommendedUnit
in class OneUnit
syntax
- one of the syntaxes of UnitParser
OneUnit.isRecognisedUnit(java.lang.String)
public boolean satisfiesUsageConstraints(String syntax)
OneUnit
An unrecognised unit has no constraints, and so will always satisfy them; this extends to units which are unrecognised in a particular syntax.
satisfiesUsageConstraints
in class OneUnit
syntax
- one of the syntaxes of UnitParser
public String toDebugString()
OneUnit
toDebugString
in class OneUnit
public String toString()
OneUnit
UnitExpr.toString()
.
toString
in class OneUnit
public String toString(String syntax)
OneUnit
UnitExpr.toString()
.
toString
in class OneUnit
public String unitString(String syntaxName) throws UnitParserException
OneUnit
unitString
in class OneUnit
syntaxName
- one of the syntaxes of UnitParser
UnitParserException
- if the syntax is unrecognisedpublic FunctionDefinition getFunctionDefinition()
getFunctionName()
returns
non-null, and not both.
public String getFunctionName()
getFunctionDefinition()
returns
non-null, and not both.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |