Package org.djunits.value.vfloat.scalar

Class FloatElectricalPotential

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

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

org.djunits.value.vfloat.scalar.base.FloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

org.djunits.value.vfloat.scalar.FloatElectricalPotential

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatElectricalPotential>, Relative<ElectricalPotentialUnit,FloatElectricalPotential>, Value<ElectricalPotentialUnit,FloatElectricalPotential>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatElectricalPotential
extends FloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

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

Copyright (c) 2013-2024 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

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

Constructor	Description
FloatElectricalPotential(double value, ElectricalPotentialUnit unit)	Construct FloatElectricalPotential scalar using a double value.
FloatElectricalPotential(float value, ElectricalPotentialUnit unit)	Construct FloatElectricalPotential scalar.
FloatElectricalPotential(FloatElectricalPotential value)	Construct FloatElectricalPotential scalar.

Method Summary

Modifier and Type	Method	Description
final FloatElectricalResistance	divide(FloatElectricalCurrent v)	Calculate the division of FloatElectricalPotential and FloatElectricalCurrent, which results in a FloatElectricalResistance scalar.
final FloatDimensionless	divide(FloatElectricalPotential v)	Calculate the division of FloatElectricalPotential and FloatElectricalPotential, which results in a FloatDimensionless scalar.
final FloatElectricalCurrent	divide(FloatElectricalResistance v)	Calculate the division of FloatElectricalPotential and FloatElectricalResistance, which results in a FloatElectricalCurrent scalar.
final FloatElectricalPotential	instantiateRel(float value, ElectricalPotentialUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatElectricalPotential	instantiateSI(float value)	Construct FloatElectricalPotential scalar.
static FloatElectricalPotential	interpolate(FloatElectricalPotential zero, FloatElectricalPotential one, float ratio)	Interpolate between two values.
static FloatElectricalPotential	max(FloatElectricalPotential r1, FloatElectricalPotential r2)	Return the maximum value of two relative scalars.
static FloatElectricalPotential	max(FloatElectricalPotential r1, FloatElectricalPotential r2, FloatElectricalPotential... rn)	Return the maximum value of more than two relative scalars.
static FloatElectricalPotential	min(FloatElectricalPotential r1, FloatElectricalPotential r2)	Return the minimum value of two relative scalars.
static FloatElectricalPotential	min(FloatElectricalPotential r1, FloatElectricalPotential r2, FloatElectricalPotential... rn)	Return the minimum value of more than two relative scalars.
static FloatElectricalPotential	of(float value, String unitString)	Returns a FloatElectricalPotential based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final FloatMagneticFlux	times(FloatDuration v)	Calculate the multiplication of FloatElectricalPotential and FloatDuration, which results in a FloatMagneticFlux scalar.
final FloatPower	times(FloatElectricalCurrent v)	Calculate the multiplication of FloatElectricalPotential and FloatElectricalCurrent, which results in a FloatPower scalar.
static FloatElectricalPotential	valueOf(String text)	Returns a FloatElectricalPotential representation of a textual representation of a value with a unit.

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

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

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

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

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

format, format, getDisplayUnit, 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 org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final FloatElectricalPotential ZERO

Constant with value zero.

ONE

public static final FloatElectricalPotential ONE

Constant with value one.

NaN

public static final FloatElectricalPotential NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalPotential POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalPotential NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalPotential POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalPotential NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatElectricalPotential

public FloatElectricalPotential(float value,
 ElectricalPotentialUnit unit)

Construct FloatElectricalPotential scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatElectricalPotential

public FloatElectricalPotential(FloatElectricalPotential value)

Construct FloatElectricalPotential scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalPotential

public FloatElectricalPotential(double value,
 ElectricalPotentialUnit unit)

Construct FloatElectricalPotential scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatElectricalPotential instantiateRel(float value,
 ElectricalPotentialUnit unit)

Description copied from class: FloatScalarRel

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

Specified by:

instantiateRel in class FloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

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 FloatElectricalPotential instantiateSI(float value)

Construct FloatElectricalPotential scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Returns a FloatElectricalPotential 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 a localized or English 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 FloatElectricalPotential

Returns:

FloatElectricalPotential; 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 FloatElectricalPotential of(float value,
 String unitString)

Returns a FloatElectricalPotential based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatElectricalPotential; 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(FloatElectricalPotential v)

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

Parameters:

v - FloatElectricalPotential; scalar

Returns:

FloatDimensionless; scalar as a division of FloatElectricalPotential and FloatElectricalPotential

times

public final FloatPower times(FloatElectricalCurrent v)

Calculate the multiplication of FloatElectricalPotential and FloatElectricalCurrent, which results in a FloatPower scalar.

Parameters:

v - FloatElectricalPotential; scalar

Returns:

FloatPower; scalar as a multiplication of FloatElectricalPotential and FloatElectricalCurrent

divide

public final FloatElectricalResistance divide(FloatElectricalCurrent v)

Calculate the division of FloatElectricalPotential and FloatElectricalCurrent, which results in a FloatElectricalResistance scalar.

Parameters:

v - FloatElectricalPotential; scalar

Returns:

FloatElectricalResistance; scalar as a division of FloatElectricalPotential and FloatElectricalCurrent

divide

public final FloatElectricalCurrent divide(FloatElectricalResistance v)

Calculate the division of FloatElectricalPotential and FloatElectricalResistance, which results in a FloatElectricalCurrent scalar.

Parameters:

v - FloatElectricalPotential; scalar

Returns:

FloatElectricalCurrent; scalar as a division of FloatElectricalPotential and FloatElectricalResistance

times

public final FloatMagneticFlux times(FloatDuration v)

Calculate the multiplication of FloatElectricalPotential and FloatDuration, which results in a FloatMagneticFlux scalar.

Parameters:

v - FloatElectricalPotential; scalar

Returns:

FloatMagneticFlux; scalar as a multiplication of FloatElectricalPotential and FloatDuration

reciprocal

public FloatSIScalar reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions