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

Class PerceivedObjectBase

java.lang.Object

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

All Implemented Interfaces:

Comparable<PerceivedObject>, Identifiable, PerceivedObject

Direct Known Subclasses:

PerceivedDistance, PerceivedGtuSimple, PerceivedLaneBasedObjectBase

public class PerceivedObjectBase
extends Object
implements PerceivedObject

Base class for perceived objects which stores the information.

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/interfaces inherited from interface org.opentrafficsim.road.gtu.lane.perception.object.PerceivedObject

PerceivedObject.Kinematics, PerceivedObject.ObjectType

Constructor Summary

Constructors

Constructor	Description
PerceivedObjectBase(String id, PerceivedObject.ObjectType objectType, Length length, PerceivedObject.Kinematics kinematics)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getId()
PerceivedObject.Kinematics	getKinematics()	Returns information on the kinematics of the perceived object.
Length	getLength()	Returns length.
PerceivedObject.ObjectType	getObjectType()	Returns object type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.road.gtu.lane.perception.object.PerceivedObject

compareTo, getAcceleration, getDistance, getSpeed

Constructor Details

PerceivedObjectBase

public PerceivedObjectBase(String id,
 PerceivedObject.ObjectType objectType,
 Length length,
 PerceivedObject.Kinematics kinematics)

Constructor.

Parameters:

id - object id

objectType - object type

length - length of the object

kinematics - kinematics of the object

Throws:

NullPointerException - when any input argument is null

Method Details

getId

public String getId()

Specified by:

getId in interface Identifiable

getObjectType

public PerceivedObject.ObjectType getObjectType()

Description copied from interface: PerceivedObject

Returns object type.

Specified by:

getObjectType in interface PerceivedObject

Returns:

the (perceived) object Type

getLength

public Length getLength()

Description copied from interface: PerceivedObject

Returns length.

Specified by:

getLength in interface PerceivedObject

Returns:

the length of the other object

getKinematics

public PerceivedObject.Kinematics getKinematics()

Description copied from interface: PerceivedObject

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

Specified by:

getKinematics in interface PerceivedObject

Returns:

information on the kinematics of the perceived object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object