001/* 002 * Units of Measurement Reference Implementation 003 * Copyright (c) 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM. 004 * 005 * All rights reserved. 006 * 007 * Redistribution and use in source and binary forms, with or without modification, 008 * are permitted provided that the following conditions are met: 009 * 010 * 1. Redistributions of source code must retain the above copyright notice, 011 * this list of conditions and the following disclaimer. 012 * 013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions 014 * and the following disclaimer in the documentation and/or other materials provided with the distribution. 015 * 016 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products 017 * derived from this software without specific prior written permission. 018 * 019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 029 */ 030package tec.units.ri.unit; 031 032import javax.measure.Quantity; 033import javax.measure.Unit; 034import javax.measure.quantity.Acceleration; 035import javax.measure.quantity.AmountOfSubstance; 036import javax.measure.quantity.Angle; 037import javax.measure.quantity.Area; 038import javax.measure.quantity.CatalyticActivity; 039import javax.measure.quantity.Dimensionless; 040import javax.measure.quantity.ElectricCapacitance; 041import javax.measure.quantity.ElectricCharge; 042import javax.measure.quantity.ElectricConductance; 043import javax.measure.quantity.ElectricCurrent; 044import javax.measure.quantity.ElectricInductance; 045import javax.measure.quantity.ElectricPotential; 046import javax.measure.quantity.ElectricResistance; 047import javax.measure.quantity.Energy; 048import javax.measure.quantity.Force; 049import javax.measure.quantity.Frequency; 050import javax.measure.quantity.Illuminance; 051import javax.measure.quantity.Length; 052import javax.measure.quantity.LuminousFlux; 053import javax.measure.quantity.LuminousIntensity; 054import javax.measure.quantity.MagneticFlux; 055import javax.measure.quantity.MagneticFluxDensity; 056import javax.measure.quantity.Mass; 057import javax.measure.quantity.Power; 058import javax.measure.quantity.Pressure; 059import javax.measure.quantity.RadiationDoseAbsorbed; 060import javax.measure.quantity.RadiationDoseEffective; 061import javax.measure.quantity.Radioactivity; 062import javax.measure.quantity.SolidAngle; 063import javax.measure.quantity.Speed; 064import javax.measure.quantity.Temperature; 065import javax.measure.quantity.Time; 066import javax.measure.quantity.Volume; 067import javax.measure.spi.SystemOfUnits; 068 069import tec.units.ri.AbstractSystemOfUnits; 070import tec.units.ri.AbstractUnit; 071import tec.units.ri.function.AddConverter; 072import tec.units.ri.function.RationalConverter; 073import tec.units.ri.quantity.QuantityDimension; 074import tec.uom.lib.common.function.Nameable; 075 076/** 077 * <p> 078 * This class defines commonly used units. 079 * 080 * @author <a href="mailto:units@catmedia.us">Werner Keil</a> 081 * @version 1.0.3, February 28, 2017 082 * @since 1.0 083 */ 084public class Units extends AbstractSystemOfUnits implements Nameable { 085 086 public static final String SYSTEM_NAME = "Units"; // This is for ME 087 088 // compatibility, since 089 // Class.getSimpleName() 090 // isn't available. 091 092 protected Units() { 093 } 094 095 private static final Units INSTANCE = new Units(); 096 097 // ////////////// 098 // BASE UNITS // 099 // ////////////// 100 101 /** 102 * The SI base unit for electric current quantities (standard name <code>A</code>). The Ampere is that constant current which, if maintained in two 103 * straight parallel conductors of infinite length, of negligible circular cross-section, and placed 1 meter apart in vacuum, would produce between 104 * these conductors a force equal to 2 * 10-7 newton per meter of length. It is named after the French physicist Andre Ampere (1775-1836). 105 */ 106 public static final Unit<ElectricCurrent> AMPERE = addUnit(new BaseUnit<ElectricCurrent>("A", QuantityDimension.ELECTRIC_CURRENT), 107 ElectricCurrent.class); 108 109 /** 110 * The SI base unit for luminous intensity quantities (standard name <code>cd</code>). The candela is the luminous intensity, in a given direction, 111 * of a source that emits monochromatic radiation of frequency 540 * 1012 hertz and that has a radiant intensity in that direction of 1/683 watt per 112 * steradian 113 * 114 * @see <a href="http://en.wikipedia.org/wiki/Candela"> Wikipedia: Candela</a> 115 */ 116 public static final Unit<LuminousIntensity> CANDELA = addUnit(new BaseUnit<LuminousIntensity>("cd", QuantityDimension.LUMINOUS_INTENSITY), 117 LuminousIntensity.class); 118 119 /** 120 * The SI base unit for thermodynamic temperature quantities (standard name <code>K</code>). The kelvin is the 1/273.16th of the thermodynamic 121 * temperature of the triple point of water. It is named after the Scottish mathematician and physicist William Thomson 1st Lord Kelvin (1824-1907) 122 */ 123 public static final Unit<Temperature> KELVIN = addUnit(new BaseUnit<Temperature>("K", QuantityDimension.TEMPERATURE), Temperature.class); 124 125 /** 126 * The SI base unit for mass quantities (standard name <code>kg</code>). It is the only SI unit with a prefix as part of its name and symbol. The 127 * kilogram is equal to the mass of an international prototype in the form of a platinum-iridium cylinder kept at Sevres in France. 128 * 129 * @see #GRAM 130 */ 131 public static final Unit<Mass> KILOGRAM = addUnit(new BaseUnit<Mass>("kg", QuantityDimension.MASS), Mass.class); 132 133 /** 134 * The SI base unit for length quantities (standard name <code>m</code>). One metre was redefined in 1983 as the distance traveled by light in a 135 * vacuum in 1/299,792,458 of a second. 136 */ 137 public static final Unit<Length> METRE = addUnit(new BaseUnit<Length>("m", QuantityDimension.LENGTH), Length.class); 138 139 /** 140 * The SI base unit for amount of substance quantities (standard name <code>mol</code>). The mole is the amount of substance of a system which 141 * contains as many elementary entities as there are atoms in 0.012 kilogram of carbon 12. 142 */ 143 public static final Unit<AmountOfSubstance> MOLE = addUnit(new BaseUnit<AmountOfSubstance>("mol", QuantityDimension.AMOUNT_OF_SUBSTANCE), 144 AmountOfSubstance.class); 145 146 /** 147 * The SI base unit for duration quantities (standard name <code>s</code>). It is defined as the duration of 9,192,631,770 cycles of radiation 148 * corresponding to the transition between two hyperfine levels of the ground state of cesium (1967 Standard). 149 */ 150 public static final Unit<Time> SECOND = addUnit(new BaseUnit<Time>("s", QuantityDimension.TIME), Time.class); 151 152 // ////////////////////////////// 153 // SI DERIVED ALTERNATE UNITS // 154 // ////////////////////////////// 155 156 /** 157 * The SI derived unit for mass quantities (standard name <code>g</code>). The base unit for mass quantity is {@link #KILOGRAM}. 158 */ 159 public static final Unit<Mass> GRAM = addUnit(KILOGRAM.divide(1000)); 160 161 /** 162 * The SI unit for plane angle quantities (standard name <code>rad</code>). One radian is the angle between two radii of a circle such that the 163 * length of the arc between them is equal to the radius. 164 */ 165 public static final Unit<Angle> RADIAN = addUnit(new AlternateUnit<Angle>(AbstractUnit.ONE, "rad"), Angle.class); 166 167 /** 168 * The SI unit for solid angle quantities (standard name <code>sr</code>). One steradian is the solid angle subtended at the center of a sphere by 169 * an area on the surface of the sphere that is equal to the radius squared. The total solid angle of a sphere is 4*Pi steradians. 170 */ 171 public static final Unit<SolidAngle> STERADIAN = addUnit(new AlternateUnit<SolidAngle>(AbstractUnit.ONE, "sr"), SolidAngle.class); 172 173 /** 174 * The SI unit for frequency (standard name <code>Hz</code>). A unit of frequency equal to one cycle per second. After Heinrich Rudolf Hertz 175 * (1857-1894), German physicist who was the first to produce radio waves artificially. 176 */ 177 public static final Unit<Frequency> HERTZ = addUnit(new AlternateUnit<Frequency>(AbstractUnit.ONE.divide(SECOND), "Hz"), Frequency.class); 178 179 /** 180 * The SI unit for force (standard name <code>N</code>). One newton is the force required to give a mass of 1 kilogram an Force of 1 metre per 181 * second per second. It is named after the English mathematician and physicist Sir Isaac Newton (1642-1727). 182 */ 183 public static final Unit<Force> NEWTON = addUnit(new AlternateUnit<Force>(METRE.multiply(KILOGRAM).divide(SECOND.pow(2)), "N"), Force.class); 184 185 /** 186 * The SI unit for pressure, stress (standard name <code>Pa</code>). One pascal is equal to one newton per square meter. It is named after the 187 * French philosopher and mathematician Blaise Pascal (1623-1662). 188 */ 189 public static final Unit<Pressure> PASCAL = addUnit(new AlternateUnit<Pressure>(NEWTON.divide(METRE.pow(2)), "Pa"), Pressure.class); 190 191 /** 192 * The SI unit for energy, work, quantity of heat (<code>J</code>). One joule is the amount of work done when an applied force of 1 newton moves 193 * through a distance of 1 metre in the direction of the force. It is named after the English physicist James Prescott Joule (1818-1889). 194 */ 195 public static final Unit<Energy> JOULE = addUnit(new AlternateUnit<Energy>(NEWTON.multiply(METRE), "J"), Energy.class); 196 197 /** 198 * The SI unit for power, radiant, flux (standard name <code>W</code>). One watt is equal to one joule per second. It is named after the British 199 * scientist James Watt (1736-1819). 200 */ 201 public static final Unit<Power> WATT = addUnit(new AlternateUnit<Power>(JOULE.divide(SECOND), "W"), Power.class); 202 203 /** 204 * The SI unit for electric charge, quantity of electricity (standard name <code>C</code>). One Coulomb is equal to the quantity of charge 205 * transferred in one second by a steady current of one ampere. It is named after the French physicist Charles Augustin de Coulomb (1736-1806). 206 */ 207 public static final Unit<ElectricCharge> COULOMB = addUnit(new AlternateUnit<ElectricCharge>(SECOND.multiply(AMPERE), "C"), ElectricCharge.class); 208 209 /** 210 * The SI unit for electric potential difference, electromotive force (standard name <code>V</code>). One Volt is equal to the difference of 211 * electric potential between two points on a conducting wire carrying a constant current of one ampere when the power dissipated between the points 212 * is one watt. It is named after the Italian physicist Count Alessandro Volta (1745-1827). 213 */ 214 public static final Unit<ElectricPotential> VOLT = addUnit(new AlternateUnit<ElectricPotential>(WATT.divide(AMPERE), "V"), ElectricPotential.class); 215 216 /** 217 * The SI unit for capacitance (standard name <code>F</code>). One Farad is equal to the capacitance of a capacitor having an equal and opposite 218 * charge of 1 coulomb on each plate and a potential difference of 1 volt between the plates. It is named after the British physicist and chemist 219 * Michael Faraday (1791-1867). 220 */ 221 public static final Unit<ElectricCapacitance> FARAD = addUnit(new AlternateUnit<ElectricCapacitance>(COULOMB.divide(VOLT), "F"), 222 ElectricCapacitance.class); 223 224 /** 225 * The SI unit for electric resistance (standard name <code>Ohm</code>). One Ohm is equal to the resistance of a conductor in which a current of one 226 * ampere is produced by a potential of one volt across its terminals. It is named after the German physicist Georg Simon Ohm (1789-1854). 227 */ 228 public static final Unit<ElectricResistance> OHM = addUnit(new AlternateUnit<ElectricResistance>(VOLT.divide(AMPERE), "?"), 229 ElectricResistance.class); 230 231 /** 232 * The SI unit for electric conductance (standard name <code>S</code>). One Siemens is equal to one ampere per volt. It is named after the German 233 * engineer Ernst Werner von Siemens (1816-1892). 234 */ 235 public static final Unit<ElectricConductance> SIEMENS = addUnit(new AlternateUnit<ElectricConductance>(AMPERE.divide(VOLT), "S"), 236 ElectricConductance.class); 237 238 /** 239 * The SI unit for magnetic flux (standard name <code>Wb</code>). One Weber is equal to the magnetic flux that in linking a circuit of one turn 240 * produces in it an electromotive force of one volt as it is uniformly reduced to zero within one second. It is named after the German physicist 241 * Wilhelm Eduard Weber (1804-1891). 242 */ 243 public static final Unit<MagneticFlux> WEBER = addUnit(new AlternateUnit<MagneticFlux>(VOLT.multiply(SECOND), "Wb"), MagneticFlux.class); 244 245 /** 246 * The alternate unit for magnetic flux density (standard name <code>T</code>). One Tesla is equal equal to one weber per square metre. It is named 247 * after the Serbian-born American electrical engineer and physicist Nikola Tesla (1856-1943). 248 */ 249 public static final Unit<MagneticFluxDensity> TESLA = addUnit(new AlternateUnit<MagneticFluxDensity>(WEBER.divide(METRE.pow(2)), "T"), 250 MagneticFluxDensity.class); 251 252 /** 253 * The alternate unit for inductance (standard name <code>H</code>). One Henry is equal to the inductance for which an induced electromotive force 254 * of one volt is produced when the current is varied at the rate of one ampere per second. It is named after the American physicist Joseph Henry 255 * (1791-1878). 256 */ 257 public static final Unit<ElectricInductance> HENRY = addUnit(new AlternateUnit<ElectricInductance>(WEBER.divide(AMPERE), "H"), 258 ElectricInductance.class); 259 260 /** 261 * The SI unit for Celsius temperature (standard name <code>Cel</code>). This is a unit of temperature such as the freezing point of water (at one 262 * atmosphere of pressure) is 0 Cel, while the boiling point is 100 Cel. 263 */ 264 public static final Unit<Temperature> CELSIUS = addUnit(new TransformedUnit<Temperature>(KELVIN, new AddConverter(273.15))); 265 // Not mapping to Temperature since temperature is mapped to Kelvin. 266 267 /** 268 * The SI unit for activity of a radionuclide (standard name <code>Bq</code> ). One becquerel is the radiation caused by one disintegration per 269 * second. It is named after the French physicist, Antoine-Henri Becquerel (1852-1908). 270 */ 271 public static final Unit<Radioactivity> BECQUEREL = addUnit(new AlternateUnit<Radioactivity>(AbstractUnit.ONE.divide(SECOND), "Bq"), 272 Radioactivity.class); 273 274 /** 275 * The SI unit for absorbed dose, specific energy (imparted), kerma (standard name <code>Gy</code>). One gray is equal to the dose of one joule of 276 * energy absorbed per one kilogram of matter. It is named after the British physician L. H. Gray (1905-1965). 277 */ 278 public static final Unit<RadiationDoseAbsorbed> GRAY = addUnit(new AlternateUnit<RadiationDoseAbsorbed>(JOULE.divide(KILOGRAM), "Gy"), 279 RadiationDoseAbsorbed.class); 280 281 /** 282 * The SI unit for dose equivalent (standard name <code>Sv</code>). One Sievert is equal is equal to the actual dose, in grays, multiplied by a 283 * "quality factor" which is larger for more dangerous forms of radiation. It is named after the Swedish physicist Rolf Sievert (1898-1966). 284 */ 285 public static final Unit<RadiationDoseEffective> SIEVERT = addUnit(new AlternateUnit<RadiationDoseEffective>(JOULE.divide(KILOGRAM), "Sv"), 286 RadiationDoseEffective.class); 287 288 /** 289 * The SI unit for catalytic activity (standard name <code>kat</code>). 290 */ 291 public static final Unit<CatalyticActivity> KATAL = addUnit(new AlternateUnit<CatalyticActivity>(MOLE.divide(SECOND), "kat"), 292 CatalyticActivity.class); 293 294 // //////////////////////////// 295 // SI DERIVED PRODUCT UNITS // 296 // //////////////////////////// 297 298 /** 299 * The SI unit for speed quantities (standard name <code>m/s</code>). 300 */ 301 public static final Unit<Speed> METRE_PER_SECOND = addUnit(new ProductUnit<Speed>(METRE.divide(SECOND)), Speed.class); 302 303 /** 304 * The SI unit for acceleration quantities (standard name <code>m/s2</code> ). 305 */ 306 public static final Unit<Acceleration> METRE_PER_SQUARE_SECOND = addUnit(new ProductUnit<Acceleration>(METRE_PER_SECOND.divide(SECOND)), 307 Acceleration.class); 308 309 /** 310 * The SI unit for area quantities (standard name <code>m2</code>). 311 */ 312 public static final Unit<Area> SQUARE_METRE = addUnit(new ProductUnit<Area>(METRE.multiply(METRE)), Area.class); 313 314 /** 315 * The SI unit for volume quantities (standard name <code>m3</code>). 316 */ 317 public static final Unit<Volume> CUBIC_METRE = addUnit(new ProductUnit<Volume>(SQUARE_METRE.multiply(METRE)), Volume.class); 318 319 /** 320 * A unit of velocity expressing the number of international {@link #KILOMETRE kilometres} per {@link #HOUR hour} (abbreviation <code>km/h</code>). 321 */ 322 public static final Unit<Speed> KILOMETRE_PER_HOUR = addUnit(METRE_PER_SECOND.multiply(0.277778d)).asType(Speed.class); 323 324 /** 325 * The SI unit for luminous flux (standard name <code>lm</code>). One Lumen is equal to the amount of light given out through a solid angle by a 326 * source of one candela intensity radiating equally in all directions. 327 */ 328 public static final Unit<LuminousFlux> LUMEN = addUnit(new AlternateUnit<LuminousFlux>(CANDELA.multiply(STERADIAN), "lm"), LuminousFlux.class); 329 330 /** 331 * The SI unit for illuminance (standard name <code>lx</code>). One Lux is equal to one lumen per square metre. 332 */ 333 public static final Unit<Illuminance> LUX = addUnit(new AlternateUnit<Illuminance>(LUMEN.divide(METRE.pow(2)), "lx"), Illuminance.class); 334 335 // /////////////////////////////////////////////////////////////// 336 // Units outside the SI that are accepted for use with the SI. // 337 // /////////////////////////////////////////////////////////////// 338 339 /** 340 * A dimensionless unit accepted for use with SI units (standard name <code>%</code>). 341 */ 342 public static final Unit<Dimensionless> PERCENT = new TransformedUnit<Dimensionless>(AbstractUnit.ONE, new RationalConverter(1, 100)); 343 344 /** 345 * A volume unit accepted for use with SI units (standard name <code>l</code>). 346 * 347 * @see <a href="https://en.wikipedia.org/wiki/Litre"> Wikipedia: Litre</a> 348 */ 349 public static final Unit<Volume> LITRE = AbstractSystemOfUnits.Helper.addUnit(INSTANCE.units, new TransformedUnit<Volume>(CUBIC_METRE, 350 new RationalConverter(1, 1000)), "Litre", "l"); 351 352 // //////// 353 // Time // 354 // //////// 355 356 /** 357 * A time unit accepted for use with SI units (standard name <code>min</code>). 358 */ 359 public static final Unit<Time> MINUTE = new TransformedUnit<Time>("min", SECOND, RationalConverter.of(60, 1)); 360 361 /** 362 * A time unit accepted for use with SI units (standard name <code>h</code> ). 363 */ 364 public static final Unit<Time> HOUR = new TransformedUnit<Time>("h", SECOND, RationalConverter.of(60 * 60, 1)); 365 366 /** 367 * A time unit accepted for use with SI units (standard name <code>d</code> ). 368 */ 369 public static final Unit<Time> DAY = new TransformedUnit<Time>("d", SECOND, RationalConverter.of(24 * 60 * 60, 1)); 370 371 /** 372 * A unit of duration equal to 7 {@link #DAY} (standard name <code>week</code>). 373 */ 374 public static final Unit<Time> WEEK = addUnit(DAY.multiply(7)); 375 376 /** 377 * A time unit accepted for use with SI units (standard name <code>y</code> ). 378 */ 379 public static final Unit<Time> YEAR = addUnit(Units.DAY.multiply(365.2525)); 380 // using Gregorian year instead of Julian (365.25) 381 382 static { 383 // have to add AbstractUnit.ONE as Dimensionless, too 384 addUnit(AbstractUnit.ONE); 385 INSTANCE.quantityToUnit.put(Dimensionless.class, AbstractUnit.ONE); 386 } 387 388 // /////////////////// 389 // Collection View // 390 // /////////////////// 391 392 @Override 393 public String getName() { 394 return SYSTEM_NAME; 395 } 396 397 /** 398 * Returns the unique instance of this class. 399 * 400 * @return the Imperial instance. 401 */ 402 public static SystemOfUnits getInstance() { 403 return INSTANCE; 404 } 405 406 /** 407 * Adds a new unit not mapped to any specified quantity type. 408 * 409 * @param unit 410 * the unit being added. 411 * @return <code>unit</code>. 412 */ 413 private static <U extends Unit<?>> U addUnit(U unit) { 414 INSTANCE.units.add(unit); 415 return unit; 416 } 417 418 /** 419 * Adds a new unit and maps it to the specified quantity type. 420 * 421 * @param unit 422 * the unit being added. 423 * @param type 424 * the quantity type. 425 * @return <code>unit</code>. 426 */ 427 private static <U extends AbstractUnit<?>> U addUnit(U unit, Class<? extends Quantity<?>> type) { 428 INSTANCE.units.add(unit); 429 INSTANCE.quantityToUnit.put(type, unit); 430 return unit; 431 } 432 433 /** 434 * Adds a new unit not mapped to any specified quantity type and puts a text as symbol or label. 435 * 436 * @param unit 437 * the unit being added. 438 * @param name 439 * the string to use as name 440 * @param text 441 * the string to use as label or symbol 442 * @param isLabel 443 * if the string should be used as a label or not 444 * @return <code>unit</code>. 445 */ 446 /* 447 private static <U extends Unit<?>> U addUnit(U unit, String name, String text, boolean isLabel) { 448 if (isLabel) { 449 SimpleUnitFormat.getInstance().label(unit, text); 450 } 451 if (name != null && unit instanceof AbstractUnit) { 452 return Helper.addUnit(INSTANCE.units, unit, name); 453 } else { 454 INSTANCE.units.add(unit); 455 } 456 return unit; 457 } 458 */ 459 /** 460 * Adds a new unit not mapped to any specified quantity type and puts a text as symbol or label. 461 * 462 * @param unit 463 * the unit being added. 464 * @param text 465 * the string to use as label or symbol 466 * @param isLabel 467 * if the string should be used as a label or not 468 * @return <code>unit</code>. 469 */ 470 // private static <U extends Unit<?>> U addUnit(U unit, String text) { 471 // return addUnit(unit, null, text, true); 472 // } 473}