Package repast.simphony.visualization

Class ProbeEvent

java.lang.Object

repast.simphony.visualization.ProbeEvent

public class ProbeEvent
extends Object

A semantic event indicating that a probe of an object has occured.

Version:

$Revision$ $Date$

Author:

Nick Collier

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProbeEvent.Type

Constructor Summary

Constructors

Constructor	Description
ProbeEvent(Object source, List<?> probedObjects)
ProbeEvent(Object source, List<?> probedObjects, ProbeEvent.Type type)

Method Summary

Modifier and Type	Method	Description
List<?>	getProbedObjects()	Gets the list of objects that have been probed.
Object	getSource()	Gets the source of the probe.
ProbeEvent.Type	getType()	Gets the type of this probe.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbeEvent

public ProbeEvent(Object source,
                  List<?> probedObjects)

ProbeEvent

public ProbeEvent(Object source,
                  List<?> probedObjects,
                  ProbeEvent.Type type)

Method Detail

getProbedObjects

public List<?> getProbedObjects()

Gets the list of objects that have been probed.

Returns:

the list of objects that have been probed.

getSource

public Object getSource()

Gets the source of the probe. For example, if the probing is done via a mouse in an IDisplay's panel, then the source will be the IDisplay.

Returns:

the source of the probe.

getType

public ProbeEvent.Type getType()

Gets the type of this probe.

Returns:

the type of this probe.