Package gda.device.scannable

Class EnergyPositionConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

java.lang.Object

gda.device.scannable.EnergyPositionConverter<S,T>

Type Parameters:

S -

T -

All Implemented Interfaces:

IConverter<javax.measure.Quantity<S>,javax.measure.Quantity<T>>, IQuantityConverter<S,T>

public class EnergyPositionConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>
extends Object
implements IQuantityConverter<S,T>

Convert between energy and position using motor parameters from TurboXasScannable. i.e. TurboXasMotorParameters.getPositionForEnergy(double) and TurboXasMotorParameters.getEnergyForPosition(double)

Constructor Summary

Constructors

Constructor	Description
EnergyPositionConverter()

Method Summary

Modifier and Type	Method	Description
List<String>	getAcceptableSourceUnits()
List<String>	getAcceptableTargetUnits()
boolean	handlesStoT()
boolean	handlesTtoS()
void	setTurboXasScannable(TurboXasScannable turboXasScannable)
boolean	sourceMinIsTargetMax()	Returns true is the conversion reverses the sense.
javax.measure.Quantity<S>	toSource(javax.measure.Quantity<T> target)	Convert from motor position (mm) to energy (eV)
javax.measure.Quantity<T>	toTarget(javax.measure.Quantity<S> source)	Convert from energy (eV) to motor position (mm)

Methods inherited from class java.lang.Object

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

Constructor Details

EnergyPositionConverter

public EnergyPositionConverter()

Method Details

setTurboXasScannable

public void setTurboXasScannable(TurboXasScannable turboXasScannable)

toSource

public javax.measure.Quantity<S> toSource(javax.measure.Quantity<T> target)
                                   throws Exception

Convert from motor position (mm) to energy (eV)

Specified by:

toSource in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

target -

Returns:

The value calculated from the value of the target *

Throws:

Exception

toTarget

public javax.measure.Quantity<T> toTarget(javax.measure.Quantity<S> source)
                                   throws Exception

Convert from energy (eV) to motor position (mm)

Specified by:

toTarget in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

source -

Returns:

The value calculated from the value of the source

Throws:

Exception

sourceMinIsTargetMax

public boolean sourceMinIsTargetMax()

Description copied from interface: IConverter

Returns true is the conversion reverses the sense. So that to get the max of the source you convert the min of the target and vice versa

Specified by:

sourceMinIsTargetMax in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true is the conversion reverses the sense.

getAcceptableSourceUnits

public List<String> getAcceptableSourceUnits()

Specified by:

getAcceptableSourceUnits in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

AcceptableSourceUnits

getAcceptableTargetUnits

public List<String> getAcceptableTargetUnits()

Specified by:

getAcceptableTargetUnits in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

AcceptableTargetUnits

handlesStoT

public boolean handlesStoT()

Specified by:

handlesStoT in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true if the converter converts from S to T

handlesTtoS

public boolean handlesTtoS()

Specified by:

handlesTtoS in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true if the converter converts from T to S