com.swath.event

Class PhotonWave

java.lang.Object

com.swath.event.PhotonWave

All Implemented Interfaces:

EventIfc

public final class PhotonWave
extends java.lang.Object

The PhotonWave event.
Posted: When a photon wave is detected.

Since:

SWATH 1.8

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Gets the event class name.
int	getDuration() Gets the duration of the wave in seconds.
int	getSector() Gets the sector where the photon wave was detected.
boolean	isEventClass(java.lang.Class eventClass) Indicates if this event matches a given event class.
boolean	isUserDefined() Indicates if this event is user defined or not.

Methods inherited from class java.lang.Object

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

Method Detail

getSector

public int getSector()

Gets the sector where the photon wave was detected.

Returns:

The sector number.

Since:

SWATH 1.8

getDuration

public int getDuration()

Gets the duration of the wave in seconds.

Returns:

The duration of the wave or 0 if it has ended.

Since:

SWATH 1.8

isEventClass

public final boolean isEventClass(java.lang.Class eventClass)

Description copied from interface: EventIfc

Indicates if this event matches a given event class.

Specified by:

isEventClass in interface EventIfc

Parameters:

eventClass - The event class.

Returns:

true if this event is of the same class, otherwise false.

isUserDefined

public final boolean isUserDefined()

Description copied from interface: EventIfc

Indicates if this event is user defined or not.

Specified by:

isUserDefined in interface EventIfc

Returns:

true if user defined, otherwise false.

getClassName

public final java.lang.String getClassName()

Description copied from interface: EventIfc

Gets the event class name.

Specified by:

getClassName in interface EventIfc

Returns:

The class name.