org.opentrafficsim.core.gtu.perception

Class AbstractPerception

java.lang.Object

org.opentrafficsim.core.gtu.perception.AbstractPerception

All Implemented Interfaces:

Serializable, Perception

public abstract class AbstractPerception
extends Object
implements Perception

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Jul 29, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPerception(GTU gtu) Construct perception.

Method Summary

Modifier and Type	Method and Description
void	addPerceptionCategory(AbstractPerceptionCategory perceptionCategory) Adds given perception category to the perception.
<T extends AbstractPerceptionCategory> boolean	contains(Class<T> clazz) Returns whether the given perception category is present.
GTU	getGtu() Return the GTU of this perception.
<T extends AbstractPerceptionCategory> T	getPerceptionCategory(Class<T> clazz) Returns the given perception category.
void	perceive() Update the perceived information and store it in a stateful manner.
void	removePerceptionCategory(AbstractPerceptionCategory perceptionCategory) Remove give perception category.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractPerception

public AbstractPerception(GTU gtu)

Construct perception.

Parameters:

gtu - GTU

Method Detail

getGtu

public GTU getGtu()

Return the GTU of this perception.

Specified by:

getGtu in interface Perception

Returns:

GTU of this perception

addPerceptionCategory

public final void addPerceptionCategory(AbstractPerceptionCategory perceptionCategory)

Adds given perception category to the perception.

Specified by:

addPerceptionCategory in interface Perception

Parameters:

perceptionCategory - perception category

contains

public final <T extends AbstractPerceptionCategory> boolean contains(Class<T> clazz)

Returns whether the given perception category is present.

Specified by:

contains in interface Perception

Type Parameters:

T - perception category

Parameters:

clazz - perception category class

Returns:

whether the given perception category is present

getPerceptionCategory

public final <T extends AbstractPerceptionCategory> T getPerceptionCategory(Class<T> clazz)
                                                                     throws OperationalPlanException

Returns the given perception category.

Specified by:

getPerceptionCategory in interface Perception

Type Parameters:

T - perception category

Parameters:

clazz - perception category class

Returns:

given perception category

Throws:

OperationalPlanException - if the perception category is not present

removePerceptionCategory

public final void removePerceptionCategory(AbstractPerceptionCategory perceptionCategory)

Remove give perception category.

Specified by:

removePerceptionCategory in interface Perception

Parameters:

perceptionCategory - perception category to remove

perceive

public void perceive()
              throws GTUException,
                     NetworkException,
                     ParameterException

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

Specified by:

perceive in interface Perception

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.

toString

public String toString()

Overrides:

toString in class Object