Package org.djunits.quantity

Class Position.Reference

java.lang.Object

org.djunits.quantity.def.AbstractReference<Position.Reference,Position,Length>

org.djunits.quantity.Position.Reference

All Implemented Interfaces:

Reference<Position.Reference,Position,Length>, org.djutils.base.Identifiable

Enclosing class:

Position

public static final class Position.Reference
extends AbstractReference<Position.Reference,Position,Length>

The reference class to define a reference point for the position. No references have been defined yet, since there is no "natural" origin for a position that we can include here. User-defined origins van be easily added and used.

Field Summary

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

REFERENCES

Constructor Summary

Constructors

Constructor	Description
Reference(String id, String name)	Define a new reference point for the position.
Reference(String id, String name, Length offset, Position.Reference offsetReference)	Define a new reference point for the position.

Method Summary

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

Constructor Details

Reference

public Reference(String id,
 String name,
 Length offset,
 Position.Reference offsetReference)

Define a new reference point for the position.

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)

Define a new reference point for the position.

Parameters:

id - the id

name - the name or explanation

Method Details

add

public static void add(String id,
 String name,
 Length offset,
 Position.Reference offsetReference)

Define a new reference point for the position.

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

add

public static void add(String id,
 String name)

Define a new reference point for the position.

Parameters:

id - the id

name - the name or explanation

get

public static Position.Reference get(String id)

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

Parameters:

id - the id

Returns:

the PositionReference object

instantiate

public Position instantiate(Length length)

Description copied from class: AbstractReference

Return a strongly typed absolute quantity belonging to this reference.

Specified by:

instantiate in interface Reference<Position.Reference,Position,Length>

Specified by:

instantiate in class AbstractReference<Position.Reference,Position,Length>

Parameters:

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

Returns:

a strongly typed absolute quantity belonging to this reference