Package jisa.devices.interfaces

Interface ProbeStation

All Superinterfaces:

Instrument, XYTranslationStage, XYZTranslationStage

All Known Implementing Classes:

Pegasus

public interface ProbeStation
extends XYZTranslationStage

Interface for defining the standard functionality of a probe station.

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
void	continMovement(java.lang.String axis, double velocityPercentage)	Write z-axis fine lift
static java.lang.String	getDescription()
double	getGrossUpDistance()
boolean	getLightOn()	Returns if light is on or not
double	getLockDistance()	Returns the z axis locking distance
void	goLoadPosition()	Moves stage to load position
void	goProbingZoneCentre()	Moves stage to Probing Zone Centre
boolean	isGrossLocked()	Returns if Gross Up or not
boolean	isLocked()	Returns if in locked position (1) or not (0)
void	setGrossUp(boolean locked)	Set Gross Up (1) or Gross Down (0)
void	setGrossUpDistance(double position)	Write z-axis gross lift
void	setLightOn(boolean lightOn)	Switches Light on (1) or off (2)
void	setLockDistance(double dist)	Write z axis locking distance
void	setLocked(boolean locked)	Write: 1 = locked position (up).

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Methods inherited from interface jisa.devices.interfaces.XYTranslationStage

getRotation, getXPosition, getXYSpeed, getYPosition, setRotation, setXPosition, setXYPosition, setXYSpeed, setYPosition

Methods inherited from interface jisa.devices.interfaces.XYZTranslationStage

getZPosition, getZSpeed, setZPosition, setZSpeed

Method Detail

getDescription

static java.lang.String getDescription()

setLockDistance

void setLockDistance(double dist)
              throws java.io.IOException,
                     DeviceException

Write z axis locking distance

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getLockDistance

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

Returns the z axis locking distance

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setLocked

void setLocked(boolean locked)
        throws java.io.IOException,
               DeviceException

Write: 1 = locked position (up). 2 = not locked (down)

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

isLocked

boolean isLocked()
          throws java.io.IOException,
                 DeviceException

Returns if in locked position (1) or not (0)

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

continMovement

void continMovement(java.lang.String axis,
                    double velocityPercentage)
             throws java.io.IOException,
                    DeviceException

Write z-axis fine lift

Parameters:

axis - : Movement axis (X,Y)

axis - : Percentage of velocity: 0 for stop, negative for movement in negative direction

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setGrossUpDistance

void setGrossUpDistance(double position)
                 throws java.io.IOException,
                        DeviceException

Write z-axis gross lift

Parameters:

position - in m

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

setGrossUp

void setGrossUp(boolean locked)
         throws java.io.IOException,
                DeviceException

Set Gross Up (1) or Gross Down (0)

Parameters:

locked - 1: up; 0: down

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

isGrossLocked

boolean isGrossLocked()
               throws java.io.IOException

Returns if Gross Up or not

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getGrossUpDistance

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

Throws:

java.io.IOException

DeviceException

setLightOn

void setLightOn(boolean lightOn)
         throws java.io.IOException,
                DeviceException

Switches Light on (1) or off (2)

Parameters:

lightOn - 1: light on; 0: light off

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getLightOn

boolean getLightOn()
            throws java.io.IOException

Returns if light is on or not

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

goLoadPosition

void goLoadPosition()
             throws java.io.IOException,
                    DeviceException

Moves stage to load position

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

goProbingZoneCentre

void goProbingZoneCentre()
                  throws java.io.IOException,
                         DeviceException

Moves stage to Probing Zone Centre

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error