Package org.djunits.quantity

Class Direction.Reference

java.lang.Object

org.djunits.quantity.def.AbstractReference<Direction.Reference,Direction,Angle>

org.djunits.quantity.Direction.Reference

All Implemented Interfaces:

Reference<Direction.Reference,Direction,Angle>, org.djutils.base.Identifiable

Enclosing class:

Direction

public static final class Direction.Reference
extends AbstractReference<Direction.Reference,Direction,Angle>

The reference class to define a reference point for the direction.

Field Summary

Fields

Modifier and Type	Field	Description
static final Direction.Reference	EAST	East is zero.
static final Direction.Reference	NORTH	North is zero.

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

REFERENCES

Constructor Summary

Constructors

Constructor	Description
Reference(String id, String name, Angle offset)	Define a new reference point for the direction.
Reference(String id, String name, Angle offset, Direction.Reference offsetReference)	Define a new reference point for the direction.

Method Summary

Modifier and Type	Method	Description
static void	add(String id, String name, Angle offset)	Define a new reference point for the direction.
static void	add(String id, String name, Angle offset, Direction.Reference offsetReference)	Define a new reference point for the direction.
static Direction.Reference	get(String id)	Get a reference point for the direction, based on its id.
Direction	instantiate(Angle angle)	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

EAST

public static final Direction.Reference EAST

East is zero.

NORTH

public static final Direction.Reference NORTH

North is zero.

Constructor Details

Reference

public Reference(String id,
 String name,
 Angle offset,
 Direction.Reference offsetReference)

Define a new reference point for the direction.

Parameters:

id - the id

name - the name or explanation

offset - the offset w.r.t. the offsetReference

offsetReference - the reference to which the offset is relative

Reference

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

Define a new reference point for the direction.

Parameters:

id - the id

name - the name or explanation

offset - the offset w.r.t. EAST

Method Details

add

public static void add(String id,
 String name,
 Angle offset,
 Direction.Reference offsetReference)

Define a new reference point for the direction.

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

add

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

Define a new reference point for the direction.

Parameters:

id - the id

name - the name or explanation

offset - the offset w.r.t. EAST

get

public static Direction.Reference get(String id)

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

Parameters:

id - the id

Returns:

the DirectionReference object

instantiate

public Direction instantiate(Angle angle)

Description copied from class: AbstractReference

Return a strongly typed absolute quantity belonging to this reference.

Specified by:

instantiate in interface Reference<Direction.Reference,Direction,Angle>

Specified by:

instantiate in class AbstractReference<Direction.Reference,Direction,Angle>

Parameters:

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

Returns:

a strongly typed absolute quantity belonging to this reference