Package org.eclipse.scanning.api.device.models

Class MalcolmModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.AbstractNameableTimeoutable

org.eclipse.scanning.api.device.models.AbstractDetectorModel

org.eclipse.scanning.api.device.models.MalcolmModel

All Implemented Interfaces:

IDetectorModel, IMalcolmModel, IReflectedModel, INameable, ITimeoutable

Direct Known Subclasses:

DummyMalcolmModel

public class MalcolmModel
extends AbstractDetectorModel
implements IMalcolmModel

The model for a malcolm device that writes h5 files.

Field Summary

Fields inherited from interface org.eclipse.scanning.api.device.models.IReflectedModel

EXCLUDED_FIELD_NAMES

Constructor Summary

Constructors

Constructor	Description
MalcolmModel()
MalcolmModel(IMalcolmModel toCopy)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<String>	getAxesToMove()	Get the names of the scan axes that are controlled by malcolm.
List<IMalcolmDetectorModel>	getDetectorModels()	Get the models for the detectors controlled by malcolm.
double	getMinExposureTime()	Get the minimum exposure time for the current malcolm model
int	hashCode()
void	setAxesToMove(List<String> axesToMove)
void	setDetectorModels(List<IMalcolmDetectorModel> detectorModels)
void	setMinExposureTime(double minExposureTime)
String	toString()

Methods inherited from class org.eclipse.scanning.api.device.models.AbstractDetectorModel

getExposureTime, setExposureTime

Methods inherited from class org.eclipse.scanning.api.AbstractNameableTimeoutable

getTimeout, setTimeout

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scanning.api.device.models.IDetectorModel

getExposureTime, setExposureTime

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Methods inherited from interface org.eclipse.scanning.api.device.models.IReflectedModel

getCommandString

Methods inherited from interface org.eclipse.scanning.api.ITimeoutable

getTimeout, setTimeout

Constructor Details

MalcolmModel

public MalcolmModel()

MalcolmModel

public MalcolmModel(IMalcolmModel toCopy)

Method Details

getMinExposureTime

public double getMinExposureTime()

Description copied from interface: IMalcolmModel

Get the minimum exposure time for the current malcolm model

Specified by:

getMinExposureTime in interface IMalcolmModel

Returns:

exposure time for current detector

setMinExposureTime

public void setMinExposureTime(double minExposureTime)

Specified by:

setMinExposureTime in interface IMalcolmModel

getAxesToMove

public List<String> getAxesToMove()

Description copied from interface: IMalcolmModel

Get the names of the scan axes that are controlled by malcolm.

Specified by:

getAxesToMove in interface IMalcolmModel

Returns:

axes to move

setAxesToMove

public void setAxesToMove(List<String> axesToMove)

Specified by:

setAxesToMove in interface IMalcolmModel

getDetectorModels

public List<IMalcolmDetectorModel> getDetectorModels()

Description copied from interface: IMalcolmModel

Get the models for the detectors controlled by malcolm.

Specified by:

getDetectorModels in interface IMalcolmModel

Returns:

malcolm detector models

setDetectorModels

public void setDetectorModels(List<IMalcolmDetectorModel> detectorModels)

Specified by:

setDetectorModels in interface IMalcolmModel

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDetectorModel

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractDetectorModel

toString

public String toString()

Overrides:

toString in class AbstractDetectorModel