org.opentrafficsim.core.gtu

Class RelativePosition

java.lang.Object

org.opentrafficsim.core.gtu.RelativePosition

All Implemented Interfaces:

Serializable

public class RelativePosition
extends Object
implements Serializable

A RelativePosition is a position on a GTU; e.g. the front, rear, position of the driver, etc.
A RelativePosition stores the offset of the position from the reference position of the GTU.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Dec 30, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelativePosition.TYPE The type of relative position, e.g., Front, Back, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static RelativePosition.TYPE	CENTER Standard relative position type CENTER.
static RelativePosition.TYPE	DRIVER Standard relative position type DRIVER.
static RelativePosition.TYPE	FRONT Standard relative position type FRONT.
static RelativePosition.TYPE	REAR Standard relative position type BACK.
static RelativePosition.TYPE	REFERENCE Standard relative position type REFERENCE.
static RelativePosition	REFERENCE_POSITION the reference position (always 0, 0, 0).

Constructor Summary

Constructors

Constructor and Description
RelativePosition(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dx, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dy, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dz, RelativePosition.TYPE type)
RelativePosition(RelativePosition p)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getDx()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getDy()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getDz()
RelativePosition.TYPE	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FRONT

public static final RelativePosition.TYPE FRONT

Standard relative position type FRONT.

REAR

public static final RelativePosition.TYPE REAR

Standard relative position type BACK.

CENTER

public static final RelativePosition.TYPE CENTER

Standard relative position type CENTER.

REFERENCE

public static final RelativePosition.TYPE REFERENCE

Standard relative position type REFERENCE.

DRIVER

public static final RelativePosition.TYPE DRIVER

Standard relative position type DRIVER.

REFERENCE_POSITION

public static final RelativePosition REFERENCE_POSITION

the reference position (always 0, 0, 0).

Constructor Detail

RelativePosition

public RelativePosition(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dx,
                        org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dy,
                        org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> dz,
                        RelativePosition.TYPE type)

Parameters:

dx - positive x is in the normal direction of movement.

dy - positive y is left compared to the normal direction of movement (seen from the top).

dz - positive z is up.

type - type of relative position (FRONT, BACK, etc.).

RelativePosition

public RelativePosition(RelativePosition p)

Parameters:

p - a relative position to make a deep copy of.

Method Detail

getDx

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getDx()

Returns:

dx.

getDy

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getDy()

Returns:

dy.

getDz

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getDz()

Returns:

dz.

getType

public final RelativePosition.TYPE getType()

Returns:

type.

toString

public final String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object