Package org.djunits.quantity

Class Temperature.Reference

java.lang.Object

org.djunits.quantity.def.AbstractReference<Temperature.Reference,Temperature,TemperatureDifference>

org.djunits.quantity.Temperature.Reference

All Implemented Interfaces:

Reference<Temperature.Reference,Temperature,TemperatureDifference>, org.djutils.base.Identifiable

Enclosing class:

Temperature

public static final class Temperature.Reference
extends AbstractReference<Temperature.Reference,Temperature,TemperatureDifference>

The reference class to define a reference point for the absolute temperature.

Field Summary

Fields

Modifier and Type	Field	Description
static final Temperature.Reference	CELSIUS	Celsius.
static final Temperature.Reference	FAHRENHEIT	Fahrenheit.
static final Temperature.Reference	KELVIN	Kelvin.

Fields inherited from class org.djunits.quantity.def.AbstractReference

REFERENCES

Constructor Summary

Constructors

Constructor	Description
Reference(String id, String name, TemperatureDifference offset)	Define a new reference point for the absolute temperature, with an offset to 0 kelvin.
Reference(String id, String name, TemperatureDifference offset, Temperature.Reference offsetReference)	Define a new reference point for an absolute temperature.

Method Summary

Modifier and Type	Method	Description
static void	add(String id, String name, TemperatureDifference offset)	Define a new reference point for the absolute temperature, with an offset to 0 kelvin.
static Temperature.Reference	get(String id)	Get a reference point for the absolute temperature, based on its id.
Temperature	instantiate(TemperatureDifference temperatureDifference)	Return a strongly typed absolute quantity belonging to this reference.

Methods inherited from class org.djunits.quantity.def.AbstractReference

containsId, equals, get, getId, getName, getOffset, getOffsetReference, getReferenceMap, hashCode, mapFor, snapshotMap, toString, unregister

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

KELVIN

public static final Temperature.Reference KELVIN

Kelvin.

CELSIUS

public static final Temperature.Reference CELSIUS

Celsius.

FAHRENHEIT

public static final Temperature.Reference FAHRENHEIT

Fahrenheit.

Constructor Details

Reference

public Reference(String id,
 String name,
 TemperatureDifference offset,
 Temperature.Reference offsetReference)

Define a new reference point for an absolute temperature.

Parameters:

id - the id

name - the name or explanation

offset - the offset w.r.t. offsetReference

offsetReference - the reference to which the offset is relative

Reference

public Reference(String id,
 String name,
 TemperatureDifference offset)

Define a new reference point for the absolute temperature, with an offset to 0 kelvin.

Parameters:

id - the id

name - the name or explanation

offset - the offset w.r.t. offsetReference

Method Details

add

public static void add(String id,
 String name,
 TemperatureDifference offset)

Define a new reference point for the absolute temperature, with an offset to 0 kelvin.

Parameters:

id - the id

name - the name or explanation

offset - the offset of this scale relative to 0 kelvin

get

public static Temperature.Reference get(String id)

Get a reference point for the absolute temperature, based on its id. Return null when the id could not be found.

Parameters:

id - the id

Returns:

the Temperature.Reference object

instantiate

public Temperature instantiate(TemperatureDifference temperatureDifference)

Description copied from class: AbstractReference

Return a strongly typed absolute quantity belonging to this reference.

Specified by:

instantiate in interface Reference<Temperature.Reference,Temperature,TemperatureDifference>

Specified by:

instantiate in class AbstractReference<Temperature.Reference,Temperature,TemperatureDifference>

Parameters:

temperatureDifference - the relative quantity that indicates the 'distance' to this reference point

Returns:

a strongly typed absolute quantity belonging to this reference