Package org.djunits.value.vfloat.scalar

Class FloatElectricalConductance

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<ElectricalConductanceUnit,FloatElectricalConductance>

org.djunits.value.vfloat.scalar.FloatElectricalConductance

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatElectricalConductance>, Scalar<ElectricalConductanceUnit,FloatElectricalConductance>, Scalar.Rel<ElectricalConductanceUnit,FloatElectricalConductance>, ValueFunctions<ElectricalConductanceUnit,FloatElectricalConductance>, Relative<ElectricalConductanceUnit,FloatElectricalConductance>, Value<ElectricalConductanceUnit,FloatElectricalConductance>, FloatScalarInterface<ElectricalConductanceUnit,FloatElectricalConductance>, FloatScalarInterface.Rel<ElectricalConductanceUnit,FloatElectricalConductance>

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

Easy access methods for the FloatElectricalConductance 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 FloatElectricalConductance	NaN	Constant with value NaN.
static FloatElectricalConductance	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static FloatElectricalConductance	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static FloatElectricalConductance	ONE	Constant with value one.
static FloatElectricalConductance	POS_MAXVALUE	Constant with value MAX_VALUE.
static FloatElectricalConductance	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static FloatElectricalConductance	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatElectricalConductance(double value, ElectricalConductanceUnit unit)	Construct FloatElectricalConductance scalar using a double value.
FloatElectricalConductance(float value, ElectricalConductanceUnit unit)	Construct FloatElectricalConductance scalar.
FloatElectricalConductance(FloatElectricalConductance value)	Construct FloatElectricalConductance scalar.

Method Summary

Modifier and Type	Method	Description
FloatDimensionless	divide(FloatElectricalConductance v)	Calculate the division of FloatElectricalConductance and FloatElectricalConductance, which results in a FloatDimensionless scalar.
FloatElectricalConductance	instantiateRel(float value, ElectricalConductanceUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static FloatElectricalConductance	instantiateSI(float value)	Construct FloatElectricalConductance scalar.
static FloatElectricalConductance	interpolate(FloatElectricalConductance zero, FloatElectricalConductance one, float ratio)	Interpolate between two values.
static FloatElectricalConductance	max(FloatElectricalConductance r1, FloatElectricalConductance r2)	Return the maximum value of two relative scalars.
static FloatElectricalConductance	max(FloatElectricalConductance r1, FloatElectricalConductance r2, FloatElectricalConductance... rn)	Return the maximum value of more than two relative scalars.
static FloatElectricalConductance	min(FloatElectricalConductance r1, FloatElectricalConductance r2)	Return the minimum value of two relative scalars.
static FloatElectricalConductance	min(FloatElectricalConductance r1, FloatElectricalConductance r2, FloatElectricalConductance... rn)	Return the minimum value of more than two relative scalars.
static FloatElectricalConductance	of(float value, String unitString)	Returns a FloatElectricalConductance based on a value and the textual representation of the unit.
FloatElectricalCapacitance	times(FloatDuration v)	Calculate the multiplication of FloatElectricalConductance and FloatDuration, which results in a FloatElectricalCapacitance scalar.
FloatElectricalCurrent	times(FloatElectricalPotential v)	Calculate the multiplication of FloatElectricalConductance and FloatElectricalPotential, which results in a FloatElectricalCurrent scalar.
static FloatElectricalConductance	valueOf(String text)	Returns a FloatElectricalConductance 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 FloatElectricalConductance ZERO

Constant with value zero.

ONE

public static final FloatElectricalConductance ONE

Constant with value one.

NaN

public static final FloatElectricalConductance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalConductance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalConductance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalConductance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalConductance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatElectricalConductance

public FloatElectricalConductance(float value, ElectricalConductanceUnit unit)

Construct FloatElectricalConductance scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatElectricalConductance

public FloatElectricalConductance(FloatElectricalConductance value)

Construct FloatElectricalConductance scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalConductance

public FloatElectricalConductance(double value, ElectricalConductanceUnit unit)

Construct FloatElectricalConductance scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatElectricalConductance instantiateRel(float value, ElectricalConductanceUnit 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 FloatElectricalConductance instantiateSI(float value)

Construct FloatElectricalConductance scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Returns a FloatElectricalConductance 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 FloatElectricalConductance

Returns:

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

Returns a FloatElectricalConductance 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:

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

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

Parameters:

v - FloatElectricalConductance scalar

Returns:

FloatDimensionless scalar as a division of FloatElectricalConductance and FloatElectricalConductance

times

public final FloatElectricalCurrent times(FloatElectricalPotential v)

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

Parameters:

v - FloatElectricalConductance scalar

Returns:

FloatElectricalCurrent scalar as a multiplication of FloatElectricalConductance and FloatElectricalPotential

times

public final FloatElectricalCapacitance times(FloatDuration v)

Calculate the multiplication of FloatElectricalConductance and FloatDuration, which results in a FloatElectricalCapacitance scalar.

Parameters:

v - FloatElectricalConductance scalar

Returns:

FloatElectricalCapacitance scalar as a multiplication of FloatElectricalConductance and FloatDuration