Package org.djunits.value.vdouble.scalar

Class Angle

java.lang.Object

java.lang.Number

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

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<RU,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRelWithAbs<DirectionUnit,Direction,AngleUnit,Angle>

org.djunits.value.vdouble.scalar.Angle

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Angle>, Relative<AngleUnit,Angle>, RelWithAbs<DirectionUnit,Direction,AngleUnit,Angle>, Value<AngleUnit,Angle>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class Angle
extends DoubleScalarRelWithAbs<DirectionUnit,Direction,AngleUnit,Angle>

Easy access methods for the Relative Angle DoubleScalar.

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 Angle	NaN	Constant with value NaN.
static final Angle	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Angle	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Angle	ONE	Constant with value one.
static final Angle	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Angle	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Angle	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
Angle(double value, AngleUnit unit)	Construct Angle scalar.
Angle(Angle value)	Construct Angle scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(Angle v)	Calculate the division of Angle and Angle, which results in a Dimensionless scalar.
final Duration	divide(AngularVelocity v)	Calculate the division of Angle and AngularVelocity, which results in a Duration scalar.
final AngularVelocity	divide(Duration v)	Calculate the division of Angle and Duration, which results in a AngularVelocity scalar.
final Direction	instantiateAbs(double value, DirectionUnit unit)	Construct a new Absolute Immutable DoubleScalar of the right type.
final Angle	instantiateRel(double value, AngleUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final Angle	instantiateSI(double value)	Construct Angle scalar.
static Angle	interpolate(Angle zero, Angle one, double ratio)	Interpolate between two values.
static Angle	max(Angle r1, Angle r2)	Return the maximum value of two relative scalars.
static Angle	max(Angle r1, Angle r2, Angle... rn)	Return the maximum value of more than two relative scalars.
static Angle	min(Angle r1, Angle r2)	Return the minimum value of two relative scalars.
static Angle	min(Angle r1, Angle r2, Angle... rn)	Return the minimum value of more than two relative scalars.
static Angle	of(double value, String unitString)	Returns a Angle based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final AngularVelocity	times(Frequency v)	Calculate the multiplication of Angle and Frequency, which results in a AngularVelocity scalar.
static Angle	valueOf(String text)	Returns a Angle representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRelWithAbs

plus

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

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.Relative

divide, divide, minus, plus, times, times

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final Angle ZERO

Constant with value zero.

ONE

public static final Angle ONE

Constant with value one.

NaN

public static final Angle NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Angle POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Angle NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Angle POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Angle NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Angle

public Angle(double value,
 AngleUnit unit)

Construct Angle scalar.

Parameters:

value - double; double value

unit - AngleUnit; unit for the double value

Angle

public Angle(Angle value)

Construct Angle scalar.

Parameters:

value - Angle; Scalar from which to construct this instance

Method Details

instantiateRel

public final Angle instantiateRel(double value,
 AngleUnit unit)

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

Specified by:

instantiateRel in class DoubleScalarRel<AngleUnit,Angle>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

instantiateAbs

public final Direction instantiateAbs(double value,
 DirectionUnit unit)

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

Specified by:

instantiateAbs in class DoubleScalarRelWithAbs<DirectionUnit,Direction,AngleUnit,Angle>

Parameters:

value - double; the double value

unit - AU; the absolute unit

Returns:

A a new absolute instance of the DoubleScalar of the right type

instantiateSI

public static final Angle instantiateSI(double value)

Construct Angle scalar.

Parameters:

value - double; the double value in SI units

Returns:

Angle; the new scalar with the SI value

interpolate

public static Angle interpolate(Angle zero,
 Angle one,
 double ratio)

Interpolate between two values.

Parameters:

zero - Angle; the low value

one - Angle; the high value

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

Returns:

Angle; a Scalar at the ratio between

max

public static Angle max(Angle r1,
 Angle r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - Angle; the first scalar

r2 - Angle; the second scalar

Returns:

Angle; the maximum value of two relative scalars

max

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

Return the maximum value of more than two relative scalars.

Parameters:

r1 - Angle; the first scalar

r2 - Angle; the second scalar

rn - Angle...; the other scalars

Returns:

Angle; the maximum value of more than two relative scalars

min

public static Angle min(Angle r1,
 Angle r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - Angle; the first scalar

r2 - Angle; the second scalar

Returns:

Angle; the minimum value of two relative scalars

min

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

Return the minimum value of more than two relative scalars.

Parameters:

r1 - Angle; the first scalar

r2 - Angle; the second scalar

rn - Angle...; the other scalars

Returns:

Angle; the minimum value of more than two relative scalars

valueOf

public static Angle valueOf(String text)

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

Returns:

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

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

Angle; 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 Dimensionless divide(Angle v)

Calculate the division of Angle and Angle, which results in a Dimensionless scalar.

Parameters:

v - Angle; scalar

Returns:

Dimensionless; scalar as a division of Angle and Angle

times

public final AngularVelocity times(Frequency v)

Calculate the multiplication of Angle and Frequency, which results in a AngularVelocity scalar.

Parameters:

v - Angle; scalar

Returns:

AngularVelocity; scalar as a multiplication of Angle and Frequency

divide

public final AngularVelocity divide(Duration v)

Calculate the division of Angle and Duration, which results in a AngularVelocity scalar.

Parameters:

v - Angle; scalar

Returns:

AngularVelocity; scalar as a division of Angle and Duration

divide

public final Duration divide(AngularVelocity v)

Calculate the division of Angle and AngularVelocity, which results in a Duration scalar.

Parameters:

v - Angle; scalar

Returns:

Duration; scalar as a division of Angle and AngularVelocity

reciprocal

public SIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<AngleUnit,Angle>

Returns:

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