View Javadoc
1   package org.djunits.unit;
2   
3   import static org.djunits.unit.unitsystem.UnitSystem.CGS_EMU;
4   import static org.djunits.unit.unitsystem.UnitSystem.CGS_ESU;
5   import static org.djunits.unit.unitsystem.UnitSystem.OTHER;
6   import static org.djunits.unit.unitsystem.UnitSystem.SI_ACCEPTED;
7   import static org.djunits.unit.unitsystem.UnitSystem.SI_DERIVED;
8   
9   import org.djunits.unit.unitsystem.UnitSystem;
10  
11  /**
12   * Units for electrical charge.
13   * <p>
14   * Copyright (c) 2015-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
15   * BSD-style license. See <a href="http://djunits.org/docs/license.html">DJUNITS License</a>.
16   * <p>
17   * $LastChangedDate: 2019-01-18 00:35:01 +0100 (Fri, 18 Jan 2019) $, @version $Revision: 324 $, by $Author: averbraeck $,
18   * initial version May 15, 2014 <br>
19   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
20   */
21  public class ElectricalChargeUnit extends LinearUnit<ElectricalChargeUnit>
22  {
23      /** */
24      private static final long serialVersionUID = 20140607L;
25  
26      /** the unit of electrical current, e.g., Ampere. */
27      private final ElectricalCurrentUnit electricalCurrentUnit;
28  
29      /** the unit of time, e.g., second. */
30      private final DurationUnit durationUnit;
31  
32      /** The SI unit for electrical charge is Coulomb = A.s. */
33      public static final ElectricalChargeUnit SI;
34  
35      /** Coulomb = A.s. */
36      public static final ElectricalChargeUnit COULOMB;
37  
38      /** picoCoulomb = pA.s. */
39      public static final ElectricalChargeUnit PICOCOULOMB;
40  
41      /** nanoCoulomb = nA.s. */
42      public static final ElectricalChargeUnit NANOCOULOMB;
43  
44      /** microCoulomb = muA.s. */
45      public static final ElectricalChargeUnit MICROCOULOMB;
46  
47      /** milliCoulomb = mA.s. */
48      public static final ElectricalChargeUnit MILLICOULOMB;
49  
50      /** milliampere hour. */
51      public static final ElectricalChargeUnit MILLIAMPERE_HOUR;
52  
53      /** milliampere second. */
54      public static final ElectricalChargeUnit MILLIAMPERE_SECOND;
55  
56      /** ampere hour. */
57      public static final ElectricalChargeUnit AMPERE_HOUR;
58  
59      /** kiloampere hour. */
60      public static final ElectricalChargeUnit KILOAMPERE_HOUR;
61  
62      /** megaampere hour. */
63      public static final ElectricalChargeUnit MEGAAMPERE_HOUR;
64  
65      /** Faraday. */
66      public static final ElectricalChargeUnit FARADAY;
67  
68      /** atomic unit of charge. */
69      public static final ElectricalChargeUnit ATOMIC_UNIT;
70  
71      /** statcoulomb (CGS ESU). */
72      public static final ElectricalChargeUnit STATCOULOMB;
73  
74      /** franklin (CGS ESU). */
75      public static final ElectricalChargeUnit FRANKLIN;
76  
77      /** esu (CGS ESU). */
78      public static final ElectricalChargeUnit ESU;
79  
80      /** abcoulomb (CGS EMU). */
81      public static final ElectricalChargeUnit ABCOULOMB;
82  
83      /** emu (CGS EMU). */
84      public static final ElectricalChargeUnit EMU;
85  
86      static
87      {
88          SI = new ElectricalChargeUnit(ElectricalCurrentUnit.AMPERE, DurationUnit.SECOND, "ElectricalChargeUnit.coulomb",
89                  "ElectricalChargeUnit.C", SI_DERIVED, true);
90          COULOMB = SI;
91          PICOCOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.picocoulomb", "ElectricalChargeUnit.pC", SI_DERIVED,
92                  COULOMB, 1.0E-12, true);
93          NANOCOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.nanocoulomb", "ElectricalChargeUnit.nC", SI_DERIVED,
94                  COULOMB, 1.0E-9, true);
95          MICROCOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.microcoulomb", "ElectricalChargeUnit.muC", SI_DERIVED,
96                  COULOMB, 1.0E-6, true);
97          MILLICOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.millicoulomb", "ElectricalChargeUnit.mC", SI_DERIVED,
98                  COULOMB, 1.0E-3, true);
99          MILLIAMPERE_HOUR = new ElectricalChargeUnit(ElectricalCurrentUnit.MILLIAMPERE, DurationUnit.HOUR,
100                 "ElectricalChargeUnit.milliampere_hour", "ElectricalChargeUnit.mAh", SI_DERIVED, true);
101         AMPERE_HOUR = new ElectricalChargeUnit(ElectricalCurrentUnit.AMPERE, DurationUnit.HOUR,
102                 "ElectricalChargeUnit.ampere_hour", "ElectricalChargeUnit.Ah", SI_DERIVED, true);
103         KILOAMPERE_HOUR = new ElectricalChargeUnit(ElectricalCurrentUnit.KILOAMPERE, DurationUnit.HOUR,
104                 "ElectricalChargeUnit.kiloampere_hour", "ElectricalChargeUnit.kAh", SI_DERIVED, true);
105         MEGAAMPERE_HOUR = new ElectricalChargeUnit(ElectricalCurrentUnit.MEGAAMPERE, DurationUnit.HOUR,
106                 "ElectricalChargeUnit.megaampere_hour", "ElectricalChargeUnit.MAh", SI_DERIVED, true);
107         MILLIAMPERE_SECOND = new ElectricalChargeUnit(ElectricalCurrentUnit.MILLIAMPERE, DurationUnit.SECOND,
108                 "ElectricalChargeUnit.milliampere_hour", "ElectricalChargeUnit.mAh", SI_DERIVED, true);
109         FARADAY = new ElectricalChargeUnit("ElectricalChargeUnit.faraday", "ElectricalChargeUnit.F", OTHER, COULOMB, 96485.3383,
110                 true);
111         ATOMIC_UNIT = new ElectricalChargeUnit("ElectricalChargeUnit.atomic_unit_of_charge", "ElectricalChargeUnit.e",
112                 SI_ACCEPTED, COULOMB, 1.6021765314E-19, true);
113         STATCOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.statcoulomb", "ElectricalChargeUnit.statC", CGS_ESU,
114                 COULOMB, 3.335641E-10, true);
115         FRANKLIN = new ElectricalChargeUnit("ElectricalChargeUnit.franklin", "ElectricalChargeUnit.Fr", CGS_ESU, STATCOULOMB,
116                 1.0, true);
117         ESU = new ElectricalChargeUnit("ElectricalChargeUnit.electrostatic_unit", "ElectricalChargeUnit.esu", CGS_ESU,
118                 STATCOULOMB, 1.0, true);
119         ABCOULOMB = new ElectricalChargeUnit("ElectricalChargeUnit.abcoulomb", "ElectricalChargeUnit.abC", CGS_EMU, COULOMB,
120                 10.0, true);
121         EMU = new ElectricalChargeUnit("ElectricalChargeUnit.electromagnetic_unit", "ElectricalChargeUnit.emu", CGS_EMU,
122                 ABCOULOMB, 1.0, true);
123     }
124 
125     /**
126      * Build an ElectricalChargeUnit as an electrical current unit times a time unit. A Coulomb is an Ampere.second.
127      * @param electricalCurrentUnit ElectricalCurrentUnit; the unit of electrical current for the electrical charge unit, e.g.,
128      *            Ampere
129      * @param durationUnit DurationUnit; the unit of time for the electrical charge unit, e.g., second
130      * @param nameOrNameKey String; if standardUnit: the key to the locale file for the long name of the unit, otherwise the
131      *            name itself
132      * @param abbreviationOrAbbreviationKey String; if standardUnit: the key to the locale file for the abbreviation of the
133      *            unit, otherwise the abbreviation itself
134      * @param unitSystem UnitSystem; the unit system, e.g. SI or Imperial
135      * @param standardUnit boolean; indicates whether it is a standard unit with a definition in the locale, or a user-defined
136      *            unit
137      */
138     private ElectricalChargeUnit(final ElectricalCurrentUnit electricalCurrentUnit, final DurationUnit durationUnit,
139             final String nameOrNameKey, final String abbreviationOrAbbreviationKey, final UnitSystem unitSystem,
140             final boolean standardUnit)
141     {
142         super(nameOrNameKey, abbreviationOrAbbreviationKey, unitSystem, COULOMB,
143                 electricalCurrentUnit.getScaleFactor() * durationUnit.getScaleFactor(), standardUnit);
144         this.electricalCurrentUnit = electricalCurrentUnit;
145         this.durationUnit = durationUnit;
146     }
147 
148     /**
149      * Build a user-defined ElectricalChargeUnit as an electrical current unit times a time unit.
150      * @param electricalCurrentUnit ElectricalCurrentUnit; the unit of electrical current for the electrical charge unit, e.g.,
151      *            Ampere
152      * @param durationUnit DurationUnit; the unit of time for the electrical charge unit, e.g., second
153      * @param name String; the long name of the unit
154      * @param abbreviation String; the abbreviation of the unit
155      * @param unitSystem UnitSystem; the unit system, e.g. SI or Imperial
156      */
157     public ElectricalChargeUnit(final ElectricalCurrentUnit electricalCurrentUnit, final DurationUnit durationUnit,
158             final String name, final String abbreviation, final UnitSystem unitSystem)
159     {
160         this(electricalCurrentUnit, durationUnit, name, abbreviation, unitSystem, false);
161     }
162 
163     /**
164      * Build a unit with a conversion factor to another unit, e.g., an abcoulomb is 10 Coulomb.
165      * @param nameOrNameKey String; if standardUnit: the key to the locale file for the long name of the unit, otherwise the
166      *            name itself
167      * @param abbreviationOrAbbreviationKey String; if standardUnit: the key to the locale file for the abbreviation of the
168      *            unit, otherwise the abbreviation itself
169      * @param unitSystem UnitSystem; the unit system, e.g. SI or Imperial
170      * @param referenceUnit ElectricalChargeUnit; the unit to convert to
171      * @param scaleFactorToReferenceUnit double; multiply a value in this unit by the factor to convert to the given reference
172      *            unit
173      * @param standardUnit boolean; indicates whether it is a standard unit with a definition in the locale, or a user-defined
174      *            unit
175      */
176     private ElectricalChargeUnit(final String nameOrNameKey, final String abbreviationOrAbbreviationKey,
177             final UnitSystem unitSystem, final ElectricalChargeUnit referenceUnit, final double scaleFactorToReferenceUnit,
178             final boolean standardUnit)
179     {
180         super(nameOrNameKey, abbreviationOrAbbreviationKey, unitSystem, referenceUnit, scaleFactorToReferenceUnit,
181                 standardUnit);
182         this.electricalCurrentUnit = referenceUnit.getElectricalCurrentUnit();
183         this.durationUnit = referenceUnit.getDurationUnit();
184     }
185 
186     /**
187      * Build a user-defined unit with a conversion factor to another unit.
188      * @param name String; the long name of the unit
189      * @param abbreviation String; the abbreviation of the unit
190      * @param unitSystem UnitSystem; the unit system, e.g. SI or Imperial
191      * @param referenceUnit ElectricalChargeUnit; the unit to convert to
192      * @param scaleFactorToReferenceUnit double; multiply a value in this unit by the factor to convert to the given reference
193      *            unit
194      */
195     public ElectricalChargeUnit(final String name, final String abbreviation, final UnitSystem unitSystem,
196             final ElectricalChargeUnit referenceUnit, final double scaleFactorToReferenceUnit)
197     {
198         this(name, abbreviation, unitSystem, referenceUnit, scaleFactorToReferenceUnit, false);
199     }
200 
201     /**
202      * @return electricalCurrentUnit
203      */
204     public final ElectricalCurrentUnit getElectricalCurrentUnit()
205     {
206         return this.electricalCurrentUnit;
207     }
208 
209     /**
210      * @return durationUnit
211      */
212     public final DurationUnit getDurationUnit()
213     {
214         return this.durationUnit;
215     }
216 
217     /** {@inheritDoc} */
218     @Override
219     public final ElectricalChargeUnit getStandardUnit()
220     {
221         return COULOMB;
222     }
223 
224     /** {@inheritDoc} */
225     @Override
226     public final String getSICoefficientsString()
227     {
228         return "sA";
229     }
230 
231 }