Package org.eclipse.scanning.api.malcolm.event

Class MalcolmEvent

java.lang.Object

java.util.EventObject

org.eclipse.scanning.api.malcolm.event.MalcolmEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MalcolmStateChangedEvent, MalcolmStepsCompletedEvent

public abstract class MalcolmEvent
extends EventObject

Abstract superclass of events from a malcolm device.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MalcolmEvent.MalcolmEventType

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MalcolmEvent(IMalcolmDevice malcolmDevice, MalcolmEvent.MalcolmEventType type, String message)

Method Summary

Modifier and Type	Method	Description
MalcolmEvent	copy()
boolean	equals(Object obj)
static MalcolmStateChangedEvent	forStateChange(IMalcolmDevice malcolmDevice, DeviceState deviceState, DeviceState prevState, String message)
static MalcolmStepsCompletedEvent	forStepsCompleted(IMalcolmDevice malcolmDevice, int stepsCompleted, String message)
MalcolmEvent.MalcolmEventType	getEventType()
IMalcolmDevice	getMalcolmDevice()
String	getMalcolmDeviceName()
String	getMessage()
int	hashCode()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MalcolmEvent

protected MalcolmEvent(IMalcolmDevice malcolmDevice,
 MalcolmEvent.MalcolmEventType type,
 String message)

Method Details

copy

public MalcolmEvent copy()

forStateChange

public static MalcolmStateChangedEvent forStateChange(IMalcolmDevice malcolmDevice,
 DeviceState deviceState,
 DeviceState prevState,
 String message)

forStepsCompleted

public static MalcolmStepsCompletedEvent forStepsCompleted(IMalcolmDevice malcolmDevice,
 int stepsCompleted,
 String message)

getMalcolmDevice

public IMalcolmDevice getMalcolmDevice()

getMalcolmDeviceName

public String getMalcolmDeviceName()

getEventType

public MalcolmEvent.MalcolmEventType getEventType()

getMessage

public String getMessage()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object