Package org.djunits.value.vfloat.scalar.base

Interface FloatScalarInterface<U extends Unit<U>,S extends FloatScalarInterface<U,S>>

Type Parameters:

U - the unit for which this is the interface

S - the scalar type belonging to the unit

All Superinterfaces:

Cloneable, Comparable<S>, Scalar<U,S>, Serializable, Value<U,S>, ValueFunctions<U,S>

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractFloatScalar, AbstractFloatScalarAbs, AbstractFloatScalarRel, AbstractFloatScalarRelWithAbs, FloatAbsoluteTemperature, FloatAbsorbedDose, FloatAcceleration, FloatAmountOfSubstance, FloatAngle, FloatAngularAcceleration, FloatAngularVelocity, FloatArea, FloatCatalyticActivity, FloatDensity, FloatDimensionless, FloatDirection, FloatDuration, FloatElectricalCapacitance, FloatElectricalCharge, FloatElectricalConductance, FloatElectricalCurrent, FloatElectricalInductance, FloatElectricalPotential, FloatElectricalResistance, FloatEnergy, FloatEquivalentDose, FloatFlowMass, FloatFlowVolume, FloatForce, FloatFrequency, FloatIlluminance, FloatLength, FloatLinearDensity, FloatLuminousFlux, FloatLuminousIntensity, FloatMagneticFlux, FloatMagneticFluxDensity, FloatMass, FloatMomentum, FloatPosition, FloatPower, FloatPressure, FloatRadioActivity, FloatSIScalar, FloatSolidAngle, FloatSpeed, FloatTemperature, FloatTime, FloatTorque, FloatVolume

public interface FloatScalarInterface<U extends Unit<U>,S extends FloatScalarInterface<U,S>>
extends Scalar<U,S>

Float scalar functions.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	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>>	Methods for Absolute Scalar.
static interface	FloatScalarInterface.Rel<U extends Unit<U>,R extends FloatScalarInterface.Rel<U,R>>	Methods for Relative FloatScalar.
static interface	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>>	Additional methods for Relative Scalar that has a corresponding Absolute Scalar.

Method Summary

Modifier and Type	Method	Description
float	getInUnit()	Retrieve the value in the original unit.
float	getInUnit(U targetUnit)	Retrieve the value converted into some specified unit.
float	getSI()	Retrieve the value in the underlying SI unit.

Methods inherited from interface java.lang.Comparable

compareTo

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

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

Methods inherited from interface org.djunits.value.Value

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

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Method Detail

getSI

float getSI()

Retrieve the value in the underlying SI unit.

Returns:

float

getInUnit

float getInUnit()

Retrieve the value in the original unit.

Returns:

float

getInUnit

float getInUnit(U targetUnit)

Retrieve the value converted into some specified unit.

Parameters:

targetUnit - U; the unit to convert the value into

Returns:

float