Package uk.ac.diamond.daq.experiment.plan

Class SampleEnvironmentVariable

java.lang.Object

gda.factory.FindableBase

uk.ac.diamond.daq.experiment.plan.SampleEnvironmentVariable

All Implemented Interfaces:

Findable, ISampleEnvironmentVariable

public class SampleEnvironmentVariable
extends FindableBase
implements ISampleEnvironmentVariable

Instances of this class will poll a Scannable at a specified frequency, and when the signal changes significantly (i.e. change >= tolerance), will notify its SEVListeners. It will stop sampling if there are no listeners registered.

Constructor Summary

Constructors

Constructor	Description
SampleEnvironmentVariable(Scannable scannable)
SampleEnvironmentVariable(Scannable scannable, double tolerance)
SampleEnvironmentVariable(DoubleSupplier externalSource)
SampleEnvironmentVariable(DoubleSupplier externalSource, double tolerance)

Method Summary

Modifier and Type	Method	Description
void	addListener(SEVListener listener)	Register either an ITrigger or an ISegment to this SEV.
Set<SEVListener>	getListeners()
boolean	isEnabled()
double	read()
void	removeListener(SEVListener listener)	Deregister an ITrigger/ISegment from this SEV.
String	toString()

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.diamond.daq.experiment.api.plan.ISampleEnvironmentVariable

getName

Constructor Details

SampleEnvironmentVariable

public SampleEnvironmentVariable(Scannable scannable)

SampleEnvironmentVariable

public SampleEnvironmentVariable(Scannable scannable,
 double tolerance)

SampleEnvironmentVariable

public SampleEnvironmentVariable(DoubleSupplier externalSource)

SampleEnvironmentVariable

public SampleEnvironmentVariable(DoubleSupplier externalSource,
 double tolerance)

Method Details

addListener

public void addListener(SEVListener listener)

Description copied from interface: ISampleEnvironmentVariable

Register either an ITrigger or an ISegment to this SEV. If it is the first SEVListener, the SEV will begin.

Specified by:

addListener in interface ISampleEnvironmentVariable

Parameters:

listener -

removeListener

public void removeListener(SEVListener listener)

Description copied from interface: ISampleEnvironmentVariable

Deregister an ITrigger/ISegment from this SEV. If it is the last SEVListener, the SEV will stop.

Specified by:

removeListener in interface ISampleEnvironmentVariable

Parameters:

listener -

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ISampleEnvironmentVariable

read

public double read()

Specified by:

read in interface ISampleEnvironmentVariable

getListeners

public Set<SEVListener> getListeners()

Specified by:

getListeners in interface ISampleEnvironmentVariable

toString

public String toString()

Overrides:

toString in class Object