org.djunits.value.vfloat.scalar

Class FloatPressure

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<PressureUnit,FloatPressure>

org.djunits.value.vfloat.scalar.FloatPressure

All Implemented Interfaces:

Serializable, Comparable<FloatPressure>, MathFunctionsAbs<FloatPressure>, MathFunctionsRel<FloatPressure>, Relative, Value<PressureUnit>, FloatMathFunctions<FloatPressure>, FloatScalarInterface

public class FloatPressure
extends AbstractFloatScalarRel<PressureUnit,FloatPressure>

Easy access methods for the Pressure FloatScalar, which is relative by definition. An example is Speed. Instead of:

 FloatScalar.Rel<PressureUnit> value = new FloatScalar.Rel<PressureUnit>(100.0, PressureUnit.SI);
 

we can now write:

 FloatPressure value = new FloatPressure(100.0, PressureUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-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-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatPressure	NaN constant with value NaN.
static FloatPressure	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatPressure	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatPressure	POS_MAXVALUE constant with value MAX_VALUE.
static FloatPressure	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatPressure	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatPressure(double value, PressureUnit unit) Construct FloatPressure scalar using a double value.
FloatPressure(FloatPressure value) Construct FloatPressure scalar.
FloatPressure(float value, PressureUnit unit) Construct FloatPressure scalar.

Method Summary

Modifier and Type	Method and Description
static FloatPressure	createSI(float value) Construct FloatPressure scalar.
FloatDimensionless	divideBy(FloatPressure v) Calculate the division of FloatPressure and FloatPressure, which results in a FloatDimensionless scalar.
FloatPressure	instantiateRel(float value, PressureUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatPressure	interpolate(FloatPressure zero, FloatPressure one, float ratio) Interpolate between two values.
static FloatPressure	max(FloatPressure r1, FloatPressure r2) Return the maximum value of two relative scalars.
static FloatPressure	max(FloatPressure r1, FloatPressure r2, FloatPressure... rn) Return the maximum value of more than two relative scalars.
static FloatPressure	min(FloatPressure r1, FloatPressure r2) Return the minimum value of two relative scalars.
static FloatPressure	min(FloatPressure r1, FloatPressure r2, FloatPressure... rn) Return the minimum value of more than two relative scalars.
FloatForce	multiplyBy(FloatArea v) Calculate the multiplication of FloatPressure and FloatArea, which results in a FloatForce scalar.
FloatEnergy	multiplyBy(FloatVolume v) Calculate the multiplication of FloatPressure and FloatVolume, which results in a FloatEnergy scalar.
static FloatPressure	valueOf(String text) Returns a FloatPressure representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatPressure ZERO

constant with value zero.

NaN

public static final FloatPressure NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatPressure POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatPressure NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatPressure POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatPressure NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatPressure

public FloatPressure(float value,
                     PressureUnit unit)

Construct FloatPressure scalar.

Parameters:

value - float value

unit - unit for the float value

FloatPressure

public FloatPressure(FloatPressure value)

Construct FloatPressure scalar.

Parameters:

value - Scalar from which to construct this instance

FloatPressure

public FloatPressure(double value,
                     PressureUnit unit)

Construct FloatPressure scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatPressure instantiateRel(float value,
                                          PressureUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class AbstractFloatScalarRel<PressureUnit,FloatPressure>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

R a new relative instance of the FloatScalar of the right type

createSI

public static final FloatPressure createSI(float value)

Construct FloatPressure scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatPressure interpolate(FloatPressure zero,
                                        FloatPressure one,
                                        float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatPressure max(FloatPressure r1,
                                FloatPressure r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FloatPressure max(FloatPressure r1,
                                FloatPressure r2,
                                FloatPressure... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FloatPressure min(FloatPressure r1,
                                FloatPressure r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FloatPressure min(FloatPressure r1,
                                FloatPressure r2,
                                FloatPressure... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static FloatPressure valueOf(String text)
                             throws IllegalArgumentException

Returns a FloatPressure representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a FloatPressure

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final FloatDimensionless divideBy(FloatPressure v)

Calculate the division of FloatPressure and FloatPressure, which results in a FloatDimensionless scalar.

Parameters:

v - FloatPressure scalar

Returns:

FloatDimensionless scalar as a division of FloatPressure and FloatPressure

multiplyBy

public final FloatForce multiplyBy(FloatArea v)

Calculate the multiplication of FloatPressure and FloatArea, which results in a FloatForce scalar.

Parameters:

v - FloatPressure scalar

Returns:

FloatForce scalar as a multiplication of FloatPressure and FloatArea

multiplyBy

public final FloatEnergy multiplyBy(FloatVolume v)

Calculate the multiplication of FloatPressure and FloatVolume, which results in a FloatEnergy scalar.

Parameters:

v - FloatPressure scalar

Returns:

FloatEnergy scalar as a multiplication of FloatPressure and FloatVolume