org.opentrafficsim.core.gtu.perception

Interface Perception

All Superinterfaces:

Serializable

public interface Perception
extends Serializable

The perception module of a GTU. It is responsible for perceiving (sensing) the environment of the GTU, which includes the locations of other GTUs. Perception is done at a certain time, and the perceived information might have a limited validity.

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-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 15, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
Collection<PerceivedObject>	getPerceivedObjects() Return information about the perceived objects with their (estimated) location, speed, and state.
TimeStampedObject<Collection<PerceivedObject>>	getTimeStampedPerceivedObjects() Return time stamped information about the perceived objects with their (estimated) location, speed, and state.
void	perceive() Update the perceived information and store it in a stateful manner.

Method Detail

perceive

void perceive()
       throws GTUException,
              NetworkException,
              ParameterException

Update the perceived information and store it in a stateful manner.

Throws:

GTUException - when GTU has not been properly initialized.

NetworkException - in case of inconsistencies in the network during perception calculations.

ParameterException - in case of a parameter error.

getPerceivedObjects

Collection<PerceivedObject> getPerceivedObjects()

Return information about the perceived objects with their (estimated) location, speed, and state.

Returns:

a collection of objects within the perception range and angle

getTimeStampedPerceivedObjects

TimeStampedObject<Collection<PerceivedObject>> getTimeStampedPerceivedObjects()
                                                                       throws GTUException

Return time stamped information about the perceived objects with their (estimated) location, speed, and state.

Returns:

a time stamped collection of objects within the perception range and angle

Throws:

GTUException - when the GTU was not initialized yet.