Package org.opentrafficsim.road.gtu.lane.perception.object

Interface PerceivedObject

All Superinterfaces:

Comparable<PerceivedObject>, Identifiable

All Known Subinterfaces:

PerceivedConflict, PerceivedGtu, PerceivedLaneBasedObject

All Known Implementing Classes:

LocalDistractionPerception.PerceivedLocalDistraction, PerceivedBusStop, PerceivedConflictFull, PerceivedDistance, PerceivedGtuBase, PerceivedGtuSimple, PerceivedLaneBasedObjectBase, PerceivedObjectBase, PerceivedTrafficLight, PerceivedTrafficLightChannel

public interface PerceivedObject
extends Identifiable, Comparable<PerceivedObject>

Interface for perceived objects including kinematics. Kinematics describe either a static or dynamic object at a certain distance of, or as adjacent to, a reference object (e.g. the perceiving GTU or a conflict).

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PerceivedObject.Kinematics	Information on the kinematics of the perceived object.
static enum	PerceivedObject.ObjectType	Type of object.

Method Summary

Modifier and Type	Method	Description
default int	compareTo(PerceivedObject headway)
default Acceleration	getAcceleration()	Returns the acceleration from the kinematics.
default Length	getDistance()	Returns the distance from the kinematics.
PerceivedObject.Kinematics	getKinematics()	Returns information on the kinematics of the perceived object.
Length	getLength()	Returns length.
PerceivedObject.ObjectType	getObjectType()	Returns object type.
default Speed	getSpeed()	Returns the speed from the kinematics.

Methods inherited from interface org.djutils.base.Identifiable

getId

Method Details

getObjectType

PerceivedObject.ObjectType getObjectType()

Returns object type.

Returns:

the (perceived) object Type

getLength

Length getLength()

Returns length.

Returns:

the length of the other object

getKinematics

PerceivedObject.Kinematics getKinematics()

Returns information on the kinematics of the perceived object. This includes position, speed, acceleration and overlap.

Returns:

information on the kinematics of the perceived object

getDistance

default Length getDistance()

Returns the distance from the kinematics.

Returns:

the distance from the kinematics

getSpeed

default Speed getSpeed()

Returns the speed from the kinematics.

Returns:

the speed from the kinematics

getAcceleration

default Acceleration getAcceleration()

Returns the acceleration from the kinematics.

Returns:

the acceleration from the kinematics

compareTo

default int compareTo(PerceivedObject headway)

Specified by:

compareTo in interface Comparable<PerceivedObject>