model.environment.objects.physicalObject.sensor

Class Sensor

java.lang.Object

model.map.MapComponent

model.map.PhysicalMapComponent

model.map.shapes.PolygonMapComponent

model.environment.objects.physicalObject.sensor.Sensor

All Implemented Interfaces:

PolygonShape, SimulationObject

Direct Known Subclasses:

WalkThroughMetalDetector, XRaySensor

public abstract class Sensor
extends PolygonMapComponent

A sensor can sense something in the world.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
protected SensorState	state The sensor state.

Fields inherited from class model.map.shapes.PolygonMapComponent

shape

Fields inherited from class model.map.PhysicalMapComponent

position

Fields inherited from class model.map.MapComponent

map

Constructor Summary

Constructors

Constructor and Description
Sensor(java.util.List<Position> corners) Creates a sensor.

Method Summary

Modifier and Type	Method and Description
abstract Observation<?>	getObservation() Gets an Observation from the sensor.

Methods inherited from class model.map.shapes.PolygonMapComponent

contains, contains, generatePosition, generatePosition, generatePositions, generatePositions, getCorners, getVectorToPosition, isCollision, isLineCollision, toString

Methods inherited from class model.map.PhysicalMapComponent

getDistance, getPosition

Methods inherited from class model.map.MapComponent

isDestroyed

Methods inherited from class java.lang.Object

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

Field Detail

state

protected SensorState state

The sensor state.

Constructor Detail

Sensor

public Sensor(java.util.List<Position> corners)

Creates a sensor.

Parameters:

corners - The positions.

Method Detail

getObservation

public abstract Observation<?> getObservation()

Gets an Observation from the sensor.

Returns:

The observation.