org.opentrafficsim.core.unit

Class TorqueUnit

java.lang.Object

org.opentrafficsim.core.unit.Unit<TorqueUnit>

org.opentrafficsim.core.unit.TorqueUnit

All Implemented Interfaces:

Serializable

public class TorqueUnit
extends Unit<TorqueUnit>

The units of torque (moment of force).

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

Version:

May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TorqueUnit	FOOT_POUND_FORCE foot pound-force.
static TorqueUnit	INCH_POUND_FORCE inch pound-force.
static TorqueUnit	METER_KILOGRAM_FORCE meter kilogram-force.
static TorqueUnit	NEWTON_METER Newton meter.
static TorqueUnit	SI The SI unit for torque is Newton meter.

Constructor Summary

Constructors

Constructor and Description
TorqueUnit(ForceUnit forceUnit, LengthUnit lengthUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Create a torque unit from force and length units.
TorqueUnit(MassUnit massUnit, LengthUnit lengthUnit, TimeUnit timeUnit, String nameKey, String abbreviationKey, UnitSystem unitSystem) Create a torque unit from mass, length and time units.
TorqueUnit(String nameKey, String abbreviationKey, UnitSystem unitSystem, TorqueUnit referenceUnit, double conversionFactorToReferenceUnit) Construct a torque unit based on another torque unit.

Method Summary

Methods

Modifier and Type	Method and Description
LengthUnit	getLengthUnit()
MassUnit	getMassUnit()
String	getSICoefficientsString()
TorqueUnit	getStandardUnit()
TimeUnit	getTimeUnit()

Methods inherited from class org.opentrafficsim.core.unit.Unit

getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getConversionFactorToStandardUnit, getName, getNameKey, getSICoefficients, getUnits, getUnitSystem, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SI

public static final TorqueUnit SI

The SI unit for torque is Newton meter.

NEWTON_METER

public static final TorqueUnit NEWTON_METER

Newton meter.

METER_KILOGRAM_FORCE

public static final TorqueUnit METER_KILOGRAM_FORCE

meter kilogram-force.

FOOT_POUND_FORCE

public static final TorqueUnit FOOT_POUND_FORCE

foot pound-force.

INCH_POUND_FORCE

public static final TorqueUnit INCH_POUND_FORCE

inch pound-force.

Constructor Detail

TorqueUnit

public TorqueUnit(MassUnit massUnit,
          LengthUnit lengthUnit,
          TimeUnit timeUnit,
          String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem)

Create a torque unit from mass, length and time units.

Parameters:

massUnit - the unit of mass for the torque unit, e.g., kilogram

lengthUnit - the unit of length for the torque unit, e.g., meter

timeUnit - the unit of time for the torque unit, e.g., second

nameKey - the key to the locale file for the long name of the unit

abbreviationKey - the key to the locale file for the abbreviation of the unit

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

TorqueUnit

public TorqueUnit(ForceUnit forceUnit,
          LengthUnit lengthUnit,
          String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem)

Create a torque unit from force and length units.

Parameters:

forceUnit - the unit of force for the torque unit, e.g., Newton

lengthUnit - the unit of length for the torque unit, e.g., m

nameKey - the key to the locale file for the long name of the unit

abbreviationKey - the key to the locale file for the abbreviation of the unit

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

TorqueUnit

public TorqueUnit(String nameKey,
          String abbreviationKey,
          UnitSystem unitSystem,
          TorqueUnit referenceUnit,
          double conversionFactorToReferenceUnit)

Construct a torque unit based on another torque unit.

Parameters:

nameKey - the key to the locale file for the long name of the unit

abbreviationKey - the key to the locale file for the abbreviation of the unit

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

referenceUnit - the unit to convert to

conversionFactorToReferenceUnit - 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

getTimeUnit

public final TimeUnit getTimeUnit()

Returns:

timeUnit

getStandardUnit

public final TorqueUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<TorqueUnit>

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<TorqueUnit>

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)