org.djunits.unit

Class ElectricalPotentialUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<ElectricalPotentialUnit>

org.djunits.unit.ElectricalPotentialUnit

All Implemented Interfaces:

Serializable

public class ElectricalPotentialUnit
extends LinearUnit<ElectricalPotentialUnit>

The units of electrical potential (voltage).

Copyright (c) 2015-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-02 19:06:46 +0100 (Sat, 02 Mar 2019) $, @version $Revision: 342 $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ElectricalPotentialUnit	ABVOLT abvolt.
static ElectricalPotentialUnit	GIGAVOLT gigavolt.
static ElectricalPotentialUnit	KILOVOLT kilovolt.
static ElectricalPotentialUnit	MEGAVOLT megavolt.
static ElectricalPotentialUnit	MICROVOLT microvolt.
static ElectricalPotentialUnit	MILLIVOLT millivolt.
static ElectricalPotentialUnit	NANOVOLT nanovolt.
static ElectricalPotentialUnit	SI The SI unit for electrical potential is Volt.
static ElectricalPotentialUnit	STATVOLT statvolt.
static ElectricalPotentialUnit	VOLT Volt.

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
ElectricalPotentialUnit(MassUnit massUnit, LengthUnit lengthUnit, ElectricalCurrentUnit electricalCurrentUnit, DurationUnit durationUnit, String name, String abbreviation, UnitSystem unitSystem) Define a user-defined ElectricalPotentialUnit based on its constituent base units, e.g.
ElectricalPotentialUnit(PowerUnit powerUnit, ElectricalCurrentUnit electricalCurrentUnit, String name, String abbreviation, UnitSystem unitSystem) Build a user-defined ElectricalPotentialUnit based on power divided by current (V=W/A).
ElectricalPotentialUnit(String name, String abbreviation, UnitSystem unitSystem, ElectricalPotentialUnit referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined ElectricalPotentialUnit with a conversion factor to another ElectricalPotentialUnit.

Method Summary

Modifier and Type	Method and Description
DurationUnit	getDurationUnit()
ElectricalCurrentUnit	getElectricalCurrentUnit()
LengthUnit	getLengthUnit()
MassUnit	getMassUnit()
String	getSICoefficientsString()
ElectricalPotentialUnit	getStandardUnit()

Methods inherited from class org.djunits.unit.LinearUnit

equals, equalsIgnoreNaming, getScale, getScaleFactor, hashCode

Methods inherited from class org.djunits.unit.Unit

generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getDefaultLocaleAbbreviation, getDefaultLocaleName, getDefaultLocaleTextualRepresentation, getDefaultLocaleTextualRepresentations, getDefaultTextualRepresentation, getName, getSICoefficients, getTextualRepresentations, getUnits, getUnitSystem, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SI

public static final ElectricalPotentialUnit SI

The SI unit for electrical potential is Volt.

VOLT

public static final ElectricalPotentialUnit VOLT

Volt.

NANOVOLT

public static final ElectricalPotentialUnit NANOVOLT

nanovolt.

MICROVOLT

public static final ElectricalPotentialUnit MICROVOLT

microvolt.

MILLIVOLT

public static final ElectricalPotentialUnit MILLIVOLT

millivolt.

KILOVOLT

public static final ElectricalPotentialUnit KILOVOLT

kilovolt.

MEGAVOLT

public static final ElectricalPotentialUnit MEGAVOLT

megavolt.

GIGAVOLT

public static final ElectricalPotentialUnit GIGAVOLT

gigavolt.

STATVOLT

public static final ElectricalPotentialUnit STATVOLT

statvolt.

ABVOLT

public static final ElectricalPotentialUnit ABVOLT

abvolt.

Constructor Detail

ElectricalPotentialUnit

public ElectricalPotentialUnit(MassUnit massUnit,
                               LengthUnit lengthUnit,
                               ElectricalCurrentUnit electricalCurrentUnit,
                               DurationUnit durationUnit,
                               String name,
                               String abbreviation,
                               UnitSystem unitSystem)

Define a user-defined ElectricalPotentialUnit based on its constituent base units, e.g. a V = km.m^2/A.s^3.

Parameters:

massUnit - MassUnit; the unit of mass for the electrical potential difference (voltage) unit, e.g., kilogram

lengthUnit - LengthUnit; the unit of length for the electrical potential difference (voltage) unit, e.g., meter

electricalCurrentUnit - ElectricalCurrentUnit; the unit of electrical current for the electrical potential difference (voltage) unit, e.g., Ampere

durationUnit - DurationUnit; the unit of time for the electrical potential difference (voltage) unit, e.g., second

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

ElectricalPotentialUnit

public ElectricalPotentialUnit(PowerUnit powerUnit,
                               ElectricalCurrentUnit electricalCurrentUnit,
                               String name,
                               String abbreviation,
                               UnitSystem unitSystem)

Build a user-defined ElectricalPotentialUnit based on power divided by current (V=W/A).

Parameters:

powerUnit - PowerUnit; the unit of power for the electrical potential difference (voltage) unit, e.g., Watt

electricalCurrentUnit - ElectricalCurrentUnit; the unit of electrical current for the electrical potential difference (voltage) unit, e.g., Ampere

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

ElectricalPotentialUnit

public ElectricalPotentialUnit(String name,
                               String abbreviation,
                               UnitSystem unitSystem,
                               ElectricalPotentialUnit referenceUnit,
                               double scaleFactorToReferenceUnit)

Build a user-defined ElectricalPotentialUnit with a conversion factor to another ElectricalPotentialUnit.

Parameters:

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

referenceUnit - ElectricalPotentialUnit; the unit to convert to

scaleFactorToReferenceUnit - double; multiply a value in this unit by the factor to convert to the given reference unit

Method Detail

getMassUnit

public final MassUnit getMassUnit()

Returns:

massUnit

getLengthUnit

public final LengthUnit getLengthUnit()

Returns:

lengthUnit

getElectricalCurrentUnit

public final ElectricalCurrentUnit getElectricalCurrentUnit()

Returns:

electricalCurrentUnit

getDurationUnit

public final DurationUnit getDurationUnit()

Returns:

durationUnit

getStandardUnit

public final ElectricalPotentialUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<ElectricalPotentialUnit>

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<ElectricalPotentialUnit>

Returns:

the SI standard coefficients for this unit, e.g., kgm/s2 or m-2s2A or m^-2.s^2.A or m^-2s^2A (not necessarily normalized)