rp1.rossum.event
Class RsSensorEvent

java.lang.Object
  rp1.rossum.event.RsEvent
      rp1.rossum.event.RsSensorEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

RsContactSensorEvent, RsPaintSensorEvent, RsRangeSensorEvent, RsTargetSensorEvent

public abstract class RsSensorEvent
extends RsEvent

The base class for all sensor-related events.

See Also:

Serialized Form

Field Summary

int

sensorID

Fields inherited from class rp1.rossum.event.RsEvent

eventID, EVT_ARRAY_SIZE, EVT_CONTACT_SENSOR, EVT_ENCODER_STATUS, EVT_HEARTBEAT, EVT_MAX_CODE, EVT_MOTION_HALTED, EVT_MOTION_STARTED, EVT_MOUSE_CLICK, EVT_PAINT_SENSOR, EVT_PLACEMENT, EVT_PLAN, EVT_POSITION, EVT_RANGE_SENSOR, EVT_TARGET_SELECTION, EVT_TARGET_SENSOR, EVT_TIMEOUT, simTime

Constructor Summary

RsSensorEvent(int eventID, double simTime, int sensorID)

RsSensorEvent(int eventID, double simTime, int sensorID, java.lang.String nameOfObjectDetected)

Method Summary

int	getIndex() Returns index (integer ID) of sensor which produced the event
java.lang.String	getNameOfObjectDetected() Returns name of the object that was detected when the sensor event was triggered.

Methods inherited from class rp1.rossum.event.RsEvent

consume, getEventID, getSimTime, isConsumed

Methods inherited from class java.lang.Object

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

Field Detail

sensorID

public final int sensorID

Constructor Detail

RsSensorEvent

public RsSensorEvent(int eventID,
                     double simTime,
                     int sensorID)

RsSensorEvent

public RsSensorEvent(int eventID,
                     double simTime,
                     int sensorID,
                     java.lang.String nameOfObjectDetected)

Method Detail

getIndex

public int getIndex()

Returns index (integer ID) of sensor which produced the event

Overrides:

getIndex in class RsEvent

getNameOfObjectDetected

public java.lang.String getNameOfObjectDetected()

Returns name of the object that was detected when the sensor event was triggered. Some sensors classes carry boolean status flags indicating whether the sensor detected an object. In the status is false (meaning "no detection") the return value for the name will be null.