Package jisa.devices.interfaces

Interface XYTranslationStage

All Superinterfaces:

Instrument

All Known Subinterfaces:

ProbeStation, XYZTranslationStage

All Known Implementing Classes:

Pegasus

public interface XYTranslationStage
extends Instrument

Nested Class Summary

Nested classes/interfaces inherited from interface jisa.devices.interfaces.Instrument

Instrument.AutoQuantity<S>, Instrument.OptionalQuantity<S>, Instrument.Parameter<S>, Instrument.Setter<S>, Instrument.TableQuantity

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getDescription()
double	getRotation()	Returns rotation angle theta in degrees
double	getXPosition()	Returns the x component of Position, in m.
double	getXYSpeed()	Returns the speed to the desired value in TODO.
double	getYPosition()	Returns the y component of Position, in m.
void	setRotation(double theta)	Sets the rotation angle theta to the desired value.
void	setXPosition(double xposition)	Sets the x-position to the desired value.
void	setXYPosition(double xposition, double yposition)	Sets the x- and y-position to the desired value.
void	setXYSpeed(double speed)	Sets the speed to the desired value in TODO.
void	setYPosition(double yposition)	Sets the y-position to the desired value.

Methods inherited from interface jisa.devices.interfaces.Instrument

close, getAddress, getConfigurationParameters, getConfigurationParameters, getIDN, getLockObject, getName, setTimeout

Method Detail

getDescription

static java.lang.String getDescription()

getXPosition

double getXPosition()
             throws java.io.IOException,
                    DeviceException

Returns the x component of Position, in m.

Returns:

x-Position, in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setXPosition

void setXPosition(double xposition)
           throws java.io.IOException,
                  DeviceException,
                  java.lang.InterruptedException

Sets the x-position to the desired value.

Parameters:

xposition - x-Position, in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

java.lang.InterruptedException

getYPosition

double getYPosition()
             throws java.io.IOException,
                    DeviceException

Returns the y component of Position, in m.

Returns:

y-Position, in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setYPosition

void setYPosition(double yposition)
           throws java.io.IOException,
                  DeviceException,
                  java.lang.InterruptedException

Sets the y-position to the desired value.

Parameters:

yposition - y-Position, in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

java.lang.InterruptedException

setXYPosition

void setXYPosition(double xposition,
                   double yposition)
            throws java.io.IOException,
                   DeviceException,
                   java.lang.InterruptedException

Sets the x- and y-position to the desired value.

Parameters:

xposition - x-Position, in m

yposition - y-Position, in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

java.lang.InterruptedException

setXYSpeed

void setXYSpeed(double speed)
         throws java.io.IOException,
                DeviceException

Sets the speed to the desired value in TODO.

Parameters:

speed - in TODO

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getXYSpeed

double getXYSpeed()
           throws java.io.IOException,
                  DeviceException

Returns the speed to the desired value in TODO.

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setRotation

void setRotation(double theta)
          throws java.io.IOException,
                 DeviceException,
                 java.lang.InterruptedException

Sets the rotation angle theta to the desired value.

Parameters:

theta - rotation angle, in degrees

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

java.lang.InterruptedException

getRotation

double getRotation()
            throws java.io.IOException,
                   DeviceException

Returns rotation angle theta in degrees

Returns:

rotation angle, in degrees

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error