AbstractDoubleScalar (DJUNITS 3.01.02 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,T>

Type Parameters:

U - the unit

T - the type

All Implemented Interfaces:

Serializable, Comparable<T>, Value<U>, DoubleScalarInterface

Direct Known Subclasses:

AbstractDoubleScalarAbs, AbstractDoubleScalarRel
```
public abstract class AbstractDoubleScalar<U extends Unit<U>,T extends AbstractDoubleScalar<U,T>>
extends Scalar<U>
implements DoubleScalarInterface, Comparable<T>
```
The most basic abstract class for the DoubleScalar.
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.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 15, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

double si
The value, stored in the standard SI unit.
- Fields inherited from class org.djunits.value.Scalar
  NUMBER_PATTERN

Fields
Modifier and Type	Field and Description
`double`	`si` The value, stored in the standard SI unit.

Constructor Summary

Constructors
Constructor and Description

AbstractDoubleScalar(U unit, double si)

Constructors
Constructor and Description
`AbstractDoubleScalar(U unit, double si)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(T o)`
`double`	`doubleValue()`
`boolean`	`eq(T o)` Test if this DoubleScalar is equal to a DoubleScalar.
`boolean`	`eq0()` Test if this DoubleScalar is equal to 0.0.
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`boolean`	`ge(T o)` Test if this DoubleScalar is greater than a DoubleScalar.
`boolean`	`ge0()` Test if this DoubleScalar is greater than 0.0.
`double`	`getInUnit()` Retrieve the value in the original unit.
`double`	`getInUnit(U targetUnit)` Retrieve the value converted into some specified unit.
`double`	`getSI()` Retrieve the value in the underlying SI unit.
`boolean`	`gt(T o)` Test if this DoubleScalar is greater than or equal to a DoubleScalar.
`boolean`	`gt0()` Test if this DoubleScalar is greater than or equal to 0.0.
`int`	`hashCode()`
`int`	`intValue()`
`boolean`	`le(T o)` Test if this DoubleScalar is less than or equal to a DoubleScalar.
`boolean`	`le0()` Test if this DoubleScalar is less than or equal to 0.0.
`long`	`longValue()`
`boolean`	`lt(T o)` Test if this DoubleScalar is less than a DoubleScalar.
`boolean`	`lt0()` Test if this DoubleScalar is less than 0.0.
`boolean`	`ne(T o)` Test if this DoubleScalar is not equal to a DoubleScalar.
`boolean`	`ne0()` Test if this DoubleScalar is not equal to 0.0.
`String`	`toString()`
`String`	`toString(boolean verbose, boolean withUnit)` Print this DoubleScalar with optional type and unit information.
`String`	`toString(U displayUnit)` Print this DoubleScalar with the value expressed in the specified unit.
`String`	`toString(U displayUnit, boolean verbose, boolean withUnit)` Print this DoubleScalar with the value expressed in the specified unit.

Methods inherited from class org.djunits.value.Scalar
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - si
```
public final double si
```
    The value, stored in the standard SI unit.
- Constructor Detail
  - AbstractDoubleScalar
```
AbstractDoubleScalar(U unit,
                     double si)
```
    Parameters:
    
    unit - U; the unit
    
    si - double; the si value to store
- Method Detail
  - getSI
```
public final double getSI()
```
    Retrieve the value in the underlying SI unit.
    
    Specified by:
    
    getSI in interface DoubleScalarInterface
    
    Returns:
    
    double
  - lt
```
public final boolean lt(T o)
```
    Test if this DoubleScalar is less than a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - le
```
public final boolean le(T o)
```
    Test if this DoubleScalar is less than or equal to a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - gt
```
public final boolean gt(T o)
```
    Test if this DoubleScalar is greater than or equal to a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - ge
```
public final boolean ge(T o)
```
    Test if this DoubleScalar is greater than a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - eq
```
public final boolean eq(T o)
```
    Test if this DoubleScalar is equal to a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - ne
```
public final boolean ne(T o)
```
    Test if this DoubleScalar is not equal to a DoubleScalar.
    
    Parameters:
    
    o - T, a relative typed DoubleScalar; the right hand side operand of the comparison
    
    Returns:
    
    boolean
  - lt0
```
public final boolean lt0()
```
    Test if this DoubleScalar is less than 0.0.
    
    Returns:
    
    boolean
  - le0
```
public final boolean le0()
```
    Test if this DoubleScalar is less than or equal to 0.0.
    
    Returns:
    
    boolean
  - gt0
```
public final boolean gt0()
```
    Test if this DoubleScalar is greater than or equal to 0.0.
    
    Returns:
    
    boolean
  - ge0
```
public final boolean ge0()
```
    Test if this DoubleScalar is greater than 0.0.
    
    Returns:
    
    boolean
  - eq0
```
public final boolean eq0()
```
    Test if this DoubleScalar is equal to 0.0.
    
    Returns:
    
    boolean
  - ne0
```
public final boolean ne0()
```
    Test if this DoubleScalar is not equal to 0.0.
    
    Returns:
    
    boolean
  - compareTo
```
public final int compareTo(T o)
```
    Specified by:
    
    compareTo in interface Comparable<T extends AbstractDoubleScalar<U,T>>
  - getInUnit
```
public final double getInUnit()
```
    Retrieve the value in the original unit.
    
    Specified by:
    
    getInUnit in interface DoubleScalarInterface
    
    Returns:
    
    double
  - getInUnit
```
public final double getInUnit(U targetUnit)
```
    Retrieve the value converted into some specified unit.
    
    Parameters:
    
    targetUnit - U; the unit to convert the value into
    
    Returns:
    
    double
  - intValue
```
public final int intValue()
```
    Specified by:
    
    intValue in class Number
  - longValue
```
public final long longValue()
```
    Specified by:
    
    longValue in class Number
  - floatValue
```
public final float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - doubleValue
```
public final double doubleValue()
```
    Specified by:
    
    doubleValue in class Number
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public final String toString(U displayUnit)
```
    Print this DoubleScalar with the value expressed in the specified unit.
    
    Parameters:
    
    displayUnit - U; the unit into which the value is converted for display
    
    Returns:
    
    String; printable string with the scalar contents expressed in the specified unit
  - toString
```
public final String toString(boolean verbose,
                             boolean withUnit)
```
    Print this DoubleScalar with optional type and unit information.
    
    Parameters:
    
    verbose - boolean; if true; include type info; if false; exclude type info
    
    withUnit - boolean; if true; include the unit; of false; exclude the unit
    
    Returns:
    
    String; printable string with the scalar contents
  - toString
```
public final String toString(U displayUnit,
                             boolean verbose,
                             boolean withUnit)
```
    Print this DoubleScalar with the value expressed in the specified unit.
    
    Parameters:
    
    displayUnit - U; the unit into which the value is converted for display
    
    verbose - boolean; if true; include type info; if false; exclude type info
    
    withUnit - boolean; if true; include the unit; of false; exclude the unit
    
    Returns:
    
    String; printable string with the scalar contents
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class AbstractDoubleScalar<U extends Unit<U>,T extends AbstractDoubleScalar<U,T>>

Field Summary

Fields inherited from class org.djunits.value.Scalar

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

si

Constructor Detail

AbstractDoubleScalar

Method Detail

getSI

lt

le

gt

ge

eq

ne

lt0

le0

gt0

ge0

eq0

ne0

compareTo

getInUnit

getInUnit

intValue

longValue

floatValue

doubleValue

toString

toString

toString

toString

hashCode

equals