org.opentrafficsim.core.gtu.perception

Interface Perception

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractPerception

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-2017 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
void	addPerceptionCategory(PerceptionCategory perceptionCategory) Adds given perception category to the perception.
<T extends PerceptionCategory> boolean	contains(Class<T> clazz) Returns whether the given perception category is present.
GTU	getGtu() Return the GTU of this perception.
<T extends PerceptionCategory> T	getPerceptionCategory(Class<T> category) Returns the given perception category.
void	perceive() Update the perceived information and store it in a stateful manner.
void	removePerceptionCategory(PerceptionCategory perceptionCategory) Remove give perception category.

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.

getGtu

GTU getGtu()
    throws GTUException

Return the GTU of this perception.

Returns:

GTU of this perception

Throws:

GTUException - if the GTU has not been initialized

addPerceptionCategory

void addPerceptionCategory(PerceptionCategory perceptionCategory)

Adds given perception category to the perception.

Parameters:

perceptionCategory - perception category

contains

<T extends PerceptionCategory> boolean contains(Class<T> clazz)

Returns whether the given perception category is present.

Type Parameters:

T - perception category

Parameters:

clazz - perception category class

Returns:

whether the given perception category is present

getPerceptionCategory

<T extends PerceptionCategory> T getPerceptionCategory(Class<T> category)
                                                throws OperationalPlanException

Returns the given perception category.

Type Parameters:

T - perception category

Parameters:

category - perception category class

Returns:

given perception category

Throws:

OperationalPlanException - if the perception category is not present

removePerceptionCategory

void removePerceptionCategory(PerceptionCategory perceptionCategory)

Remove give perception category.

Parameters:

perceptionCategory - perception category to remove