org.simbrain.world.visionworld

Class SensorSelectionModel

java.lang.Object

org.simbrain.world.visionworld.SensorSelectionModel

All Implemented Interfaces:

java.lang.Iterable<Sensor>

public final class SensorSelectionModel
extends java.lang.Object
implements java.lang.Iterable<Sensor>

Sensor selection model.

Constructor Summary

Constructors

Constructor and Description
SensorSelectionModel(VisionWorld visionWorld) Create a new sensor selection model with the specified vision world.

Method Summary

Modifier and Type	Method and Description
void	add(Sensor sensor) Add the specified sensor to this sensor selection model.
void	addAll(java.util.Collection<Sensor> sensors) Add all of the specified collection of sensors to this sensor selection model.
void	addSensorSelectionListener(SensorSelectionListener listener) Add the specified sensor selection listener.
void	clear() Clear this sensor selection model.
void	fireSelectionChanged(java.util.Set<Sensor> oldSelection, java.util.Set<Sensor> selection) Fire a selection changed event.
java.util.Collection<Sensor>	getSelection() Return an unmodifiable collection of selected sensors.
boolean	isEmpty() Return true if this sensor selection model is empty.
boolean	isSelected(Sensor sensor) Return true if the specified sensor is selected.
java.util.Iterator<Sensor>	iterator() Return an iterator over the selected sensors.
void	remove(Sensor sensor) Remove the specified sensor from this sensor selection model.
void	removeAll(java.util.Collection<Sensor> sensors) Remove all of the specified collection of sensors from this sensor selection model.
void	removeSensorSelectionListener(SensorSelectionListener listener) Remove the specified sensor selection listener.
void	setSelection(java.util.Collection<Sensor> sensors) Set the selection for this sensor selection model to the specified collection of sensors.
int	size() Return the number of selected sensors for this sensor selection model.
void	toggleSelection(Sensor sensor) Toggle the selection state for the specified sensor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SensorSelectionModel

SensorSelectionModel(VisionWorld visionWorld)

Create a new sensor selection model with the specified vision world.

Parameters:

visionWorld - vision world for this sensor selection model, must not be null

Method Detail

size

public int size()

Return the number of selected sensors for this sensor selection model.

Returns:

the number of selected sensors for this sensor selection model

clear

public void clear()

Clear this sensor selection model.

isEmpty

public boolean isEmpty()

Return true if this sensor selection model is empty.

Returns:

true if this sensor selection model is empty

add

public void add(Sensor sensor)

Add the specified sensor to this sensor selection model.

Parameters:

sensor - sensor to add

addAll

public void addAll(java.util.Collection<Sensor> sensors)

Add all of the specified collection of sensors to this sensor selection model.

Parameters:

sensors - collection of sensors to add

remove

public void remove(Sensor sensor)

Remove the specified sensor from this sensor selection model.

Parameters:

sensor - sensor to remove

removeAll

public void removeAll(java.util.Collection<Sensor> sensors)

Remove all of the specified collection of sensors from this sensor selection model.

Parameters:

sensors - collection of sensors to remove

isSelected

public boolean isSelected(Sensor sensor)

Return true if the specified sensor is selected.

Parameters:

sensor -

Returns:

true if the specified sensor is selected

toggleSelection

public void toggleSelection(Sensor sensor)

Toggle the selection state for the specified sensor.

Parameters:

sensor - sensor to toggle

iterator

public java.util.Iterator<Sensor> iterator()

Return an iterator over the selected sensors.

Specified by:

iterator in interface java.lang.Iterable<Sensor>

Returns:

an iterator over the selected sensors

getSelection

public java.util.Collection<Sensor> getSelection()

Return an unmodifiable collection of selected sensors.

Returns:

an unmodifiable collection of selected sensors

setSelection

public void setSelection(java.util.Collection<Sensor> sensors)

Set the selection for this sensor selection model to the specified collection of sensors.

Parameters:

sensors - collection of selected sensors

addSensorSelectionListener

public void addSensorSelectionListener(SensorSelectionListener listener)

Add the specified sensor selection listener.

Parameters:

listener - listener to add

removeSensorSelectionListener

public void removeSensorSelectionListener(SensorSelectionListener listener)

Remove the specified sensor selection listener.

Parameters:

listener - listener to remove

fireSelectionChanged

public void fireSelectionChanged(java.util.Set<Sensor> oldSelection,
                                 java.util.Set<Sensor> selection)

Fire a selection changed event.

Parameters:

oldSelection - old selection

selection - new selection