Package org.djunits.value.vfloat.scalar

Class FloatMagneticFluxDensity

java.lang.Object

java.lang.Number

org.djunits.value.AbstractScalar<U,S>

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

org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<MagneticFluxDensityUnit,FloatMagneticFluxDensity>

org.djunits.value.vfloat.scalar.FloatMagneticFluxDensity

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatMagneticFluxDensity>, Scalar<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, Scalar.Rel<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, ValueFunctions<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, Relative<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, Value<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, FloatScalarInterface<MagneticFluxDensityUnit,FloatMagneticFluxDensity>, FloatScalarInterface.Rel<MagneticFluxDensityUnit,FloatMagneticFluxDensity>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatMagneticFluxDensity
extends AbstractFloatScalarRel<MagneticFluxDensityUnit,FloatMagneticFluxDensity>

Easy access methods for the FloatMagneticFluxDensity FloatScalar, which is relative by definition.

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.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface

FloatScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>, FloatScalarInterface.Rel<U extends Unit<U>,R extends FloatScalarInterface.Rel<U,R>>, FloatScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>

Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar

Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>

Field Summary

Fields

Modifier and Type	Field	Description
static FloatMagneticFluxDensity	NaN	Constant with value NaN.
static FloatMagneticFluxDensity	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static FloatMagneticFluxDensity	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static FloatMagneticFluxDensity	ONE	Constant with value one.
static FloatMagneticFluxDensity	POS_MAXVALUE	Constant with value MAX_VALUE.
static FloatMagneticFluxDensity	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static FloatMagneticFluxDensity	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatMagneticFluxDensity(double value, MagneticFluxDensityUnit unit)	Construct FloatMagneticFluxDensity scalar using a double value.
FloatMagneticFluxDensity(float value, MagneticFluxDensityUnit unit)	Construct FloatMagneticFluxDensity scalar.
FloatMagneticFluxDensity(FloatMagneticFluxDensity value)	Construct FloatMagneticFluxDensity scalar.

Method Summary

Modifier and Type	Method	Description
FloatDimensionless	divide(FloatMagneticFluxDensity v)	Calculate the division of FloatMagneticFluxDensity and FloatMagneticFluxDensity, which results in a FloatDimensionless scalar.
FloatMagneticFluxDensity	instantiateRel(float value, MagneticFluxDensityUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static FloatMagneticFluxDensity	instantiateSI(float value)	Construct FloatMagneticFluxDensity scalar.
static FloatMagneticFluxDensity	interpolate(FloatMagneticFluxDensity zero, FloatMagneticFluxDensity one, float ratio)	Interpolate between two values.
static FloatMagneticFluxDensity	max(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2)	Return the maximum value of two relative scalars.
static FloatMagneticFluxDensity	max(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2, FloatMagneticFluxDensity... rn)	Return the maximum value of more than two relative scalars.
static FloatMagneticFluxDensity	min(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2)	Return the minimum value of two relative scalars.
static FloatMagneticFluxDensity	min(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2, FloatMagneticFluxDensity... rn)	Return the minimum value of more than two relative scalars.
static FloatMagneticFluxDensity	of(float value, String unitString)	Returns a FloatMagneticFluxDensity based on a value and the textual representation of the unit.
FloatMagneticFlux	times(FloatArea v)	Calculate the multiplication of FloatMagneticFluxDensity and FloatArea, which results in a FloatMagneticFlux scalar.
static FloatMagneticFluxDensity	valueOf(String text)	Returns a FloatMagneticFluxDensity representation of a textual representation of a value with a unit.

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

abs, ceil, divide, divide, divide, floor, minus, neg, plus, reciprocal, rint, times, times, times

Methods inherited from class org.djunits.value.vfloat.scalar.base.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.AbstractScalar

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

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 java.lang.Comparable

compareTo

Methods inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface

getInUnit, getInUnit, getSI

Methods inherited from interface org.djunits.value.base.Scalar

eq, eq0, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Field Details

ZERO

public static final FloatMagneticFluxDensity ZERO

Constant with value zero.

ONE

public static final FloatMagneticFluxDensity ONE

Constant with value one.

NaN

public static final FloatMagneticFluxDensity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatMagneticFluxDensity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatMagneticFluxDensity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatMagneticFluxDensity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatMagneticFluxDensity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatMagneticFluxDensity

public FloatMagneticFluxDensity(float value, MagneticFluxDensityUnit unit)

Construct FloatMagneticFluxDensity scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatMagneticFluxDensity

public FloatMagneticFluxDensity(FloatMagneticFluxDensity value)

Construct FloatMagneticFluxDensity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMagneticFluxDensity

public FloatMagneticFluxDensity(double value, MagneticFluxDensityUnit unit)

Construct FloatMagneticFluxDensity scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatMagneticFluxDensity instantiateRel(float value, MagneticFluxDensityUnit unit)

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

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

instantiateSI

public static final FloatMagneticFluxDensity instantiateSI(float value)

Construct FloatMagneticFluxDensity scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatMagneticFluxDensity max(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity 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 FloatMagneticFluxDensity max(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2, FloatMagneticFluxDensity... 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 FloatMagneticFluxDensity min(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity 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 FloatMagneticFluxDensity min(FloatMagneticFluxDensity r1, FloatMagneticFluxDensity r2, FloatMagneticFluxDensity... 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 FloatMagneticFluxDensity valueOf(String text)

Returns a FloatMagneticFluxDensity 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 required, between the value and the unit.

Parameters:

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

Returns:

FloatMagneticFluxDensity; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatMagneticFluxDensity of(float value, String unitString)

Returns a FloatMagneticFluxDensity based on a value and the textual representation of the unit.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatMagneticFluxDensity; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final FloatDimensionless divide(FloatMagneticFluxDensity v)

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

Parameters:

v - FloatMagneticFluxDensity scalar

Returns:

FloatDimensionless scalar as a division of FloatMagneticFluxDensity and FloatMagneticFluxDensity

times

public final FloatMagneticFlux times(FloatArea v)

Calculate the multiplication of FloatMagneticFluxDensity and FloatArea, which results in a FloatMagneticFlux scalar.

Parameters:

v - FloatMagneticFluxDensity scalar

Returns:

FloatMagneticFlux scalar as a multiplication of FloatMagneticFluxDensity and FloatArea