Package jisa.devices.probestation

Class Pegasus

java.lang.Object

jisa.visa.VISADevice

jisa.devices.probestation.Pegasus

All Implemented Interfaces:

Instrument, ProbeStation, XYTranslationStage, XYZTranslationStage

public class Pegasus
extends VISADevice
implements ProbeStation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pegasus.Status

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

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

Field Summary

Fields inherited from class jisa.visa.VISADevice

C_IDN, CR_TERMINATOR, CRLF_TERMINATOR, DEFAULT_EOI, DEFAULT_EOS, DEFAULT_TIMEOUT, EOS_RETURN, LF_TERMINATOR

Constructor Summary

Constructors

Constructor	Description
Pegasus(Address address)

Method Summary

Modifier and Type	Method	Description
protected void	checkDefaultResponse(java.lang.String str)
void	continMovement(java.lang.String axis, double velocityPercentage)	Write z-axis fine lift
static java.lang.String	getDescription()
double	getGrossUpDistance()
java.lang.String	getIDN()	Sends the standard identifications query to the device (*IDN?)
boolean	getLightOn()	Returns if light is on or not
double	getLockDistance()	Returns the z axis locking distance
double	getRotation()	Returns rotation angle theta in degrees
Pegasus.Status	getStatus()
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.
double	getZPosition()	Returns the z component of Position, in m.
double	getZSpeed()	Sets the speed to the desired value in TODO.
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)
protected double	parsePosition(java.lang.String response)
protected double	parsePosition(java.lang.String response, double divisor)
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 distance)	Write z axis locking distance
void	setLocked(boolean locked)	Write: 1 = locked position (up).
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.
void	setZPosition(double position)	Sets the x-position to the desired value.
void	setZSpeed(double speed)	Sets the speed to the desired value in TODO.
protected java.lang.String	slowQuery(java.lang.String message, java.lang.Object... params)

Methods inherited from class jisa.visa.VISADevice

addAutoRemove, checkLimit, checkLimit, clearBuffers, close, getAddress, getConnection, getName, manuallyClearReadBuffer, query, queryDouble, queryInt, read, read, readBytes, readDouble, readInt, setIOLimit, setReadBufferSize, setReadTerminator, setReadTerminator, setRetryCount, setTimeout, setWriteTerminator, write, writeBytes

Methods inherited from class java.lang.Object

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

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Constructor Detail

Pegasus

public Pegasus(Address address)
        throws java.io.IOException,
               DeviceException

Throws:

java.io.IOException

DeviceException

Method Detail

getDescription

public static java.lang.String getDescription()

slowQuery

protected java.lang.String slowQuery(java.lang.String message,
                                     java.lang.Object... params)
                              throws java.io.IOException,
                                     DeviceException

Throws:

java.io.IOException

DeviceException

checkDefaultResponse

protected void checkDefaultResponse(java.lang.String str)
                             throws DeviceException

Throws:

DeviceException

setXPosition

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

Description copied from interface: XYTranslationStage

Sets the x-position to the desired value.

Specified by:

setXPosition in interface XYTranslationStage

Parameters:

xposition - x-Position, in m

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

setYPosition

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

Description copied from interface: XYTranslationStage

Sets the y-position to the desired value.

Specified by:

setYPosition in interface XYTranslationStage

Parameters:

yposition - y-Position, in m

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

parsePosition

protected double parsePosition(java.lang.String response)
                        throws java.io.IOException

Throws:

java.io.IOException

parsePosition

protected double parsePosition(java.lang.String response,
                               double divisor)
                        throws java.io.IOException

Throws:

java.io.IOException

getXPosition

public double getXPosition()
                    throws java.io.IOException

Description copied from interface: XYTranslationStage

Returns the x component of Position, in m.

Specified by:

getXPosition in interface XYTranslationStage

Returns:

x-Position, in m

Throws:

java.io.IOException - Upon communications error

continMovement

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

Description copied from interface: ProbeStation

Write z-axis fine lift

Specified by:

continMovement in interface ProbeStation

Parameters:

axis - : Movement axis (X,Y)

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getYPosition

public double getYPosition()
                    throws java.io.IOException

Description copied from interface: XYTranslationStage

Returns the y component of Position, in m.

Specified by:

getYPosition in interface XYTranslationStage

Returns:

y-Position, in m

Throws:

java.io.IOException - Upon communications error

setXYPosition

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

Description copied from interface: XYTranslationStage

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

Specified by:

setXYPosition in interface XYTranslationStage

Parameters:

xposition - x-Position, in m

yposition - y-Position, in m

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

setZPosition

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

Description copied from interface: XYZTranslationStage

Sets the x-position to the desired value.

Specified by:

setZPosition in interface XYZTranslationStage

Parameters:

position - z-Position, in m

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

setGrossUpDistance

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

Description copied from interface: ProbeStation

Write z-axis gross lift

Specified by:

setGrossUpDistance in interface ProbeStation

Parameters:

position - in m

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

setGrossUp

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

Description copied from interface: ProbeStation

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

Specified by:

setGrossUp in interface ProbeStation

Parameters:

locked - 1: up; 0: down

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

isGrossLocked

public boolean isGrossLocked()
                      throws java.io.IOException

Description copied from interface: ProbeStation

Returns if Gross Up or not

Specified by:

isGrossLocked in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

getGrossUpDistance

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

Specified by:

getGrossUpDistance in interface ProbeStation

Throws:

java.io.IOException

DeviceException

getZPosition

public double getZPosition()
                    throws java.io.IOException

Description copied from interface: XYZTranslationStage

Returns the z component of Position, in m.

Specified by:

getZPosition in interface XYZTranslationStage

Returns:

z-Position, in m

Throws:

java.io.IOException - Upon communications error

setXYSpeed

public void setXYSpeed(double speed)

Description copied from interface: XYTranslationStage

Sets the speed to the desired value in TODO.

Specified by:

setXYSpeed in interface XYTranslationStage

Parameters:

speed - in TODO

getXYSpeed

public double getXYSpeed()

Description copied from interface: XYTranslationStage

Returns the speed to the desired value in TODO.

Specified by:

getXYSpeed in interface XYTranslationStage

setZSpeed

public void setZSpeed(double speed)

Description copied from interface: XYZTranslationStage

Sets the speed to the desired value in TODO.

Specified by:

setZSpeed in interface XYZTranslationStage

Parameters:

speed - in TODO

getZSpeed

public double getZSpeed()

Description copied from interface: XYZTranslationStage

Sets the speed to the desired value in TODO.

Specified by:

getZSpeed in interface XYZTranslationStage

setRotation

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

Description copied from interface: XYTranslationStage

Sets the rotation angle theta to the desired value.

Specified by:

setRotation in interface XYTranslationStage

Parameters:

theta - rotation angle, in degrees

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getRotation

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

Description copied from interface: XYTranslationStage

Returns rotation angle theta in degrees

Specified by:

getRotation in interface XYTranslationStage

Returns:

rotation angle, in degrees

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getIDN

public java.lang.String getIDN()
                        throws java.io.IOException

Description copied from class: VISADevice

Sends the standard identifications query to the device (*IDN?)

Specified by:

getIDN in interface Instrument

Overrides:

getIDN in class VISADevice

Returns:

The resposne of the device

Throws:

java.io.IOException - Upon communications error

setLockDistance

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

Description copied from interface: ProbeStation

Write z axis locking distance

Specified by:

setLockDistance in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getLockDistance

public double getLockDistance()
                       throws java.io.IOException

Description copied from interface: ProbeStation

Returns the z axis locking distance

Specified by:

getLockDistance in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

getStatus

public Pegasus.Status getStatus()
                         throws java.io.IOException

Throws:

java.io.IOException

setLocked

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

Description copied from interface: ProbeStation

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

Specified by:

setLocked in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

isLocked

public boolean isLocked()
                 throws java.io.IOException

Description copied from interface: ProbeStation

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

Specified by:

isLocked in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

setLightOn

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

Description copied from interface: ProbeStation

Switches Light on (1) or off (2)

Specified by:

setLightOn in interface ProbeStation

Parameters:

lightOn - 1: light on; 0: light off

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getLightOn

public boolean getLightOn()
                   throws java.io.IOException

Description copied from interface: ProbeStation

Returns if light is on or not

Specified by:

getLightOn in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

goLoadPosition

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

Description copied from interface: ProbeStation

Moves stage to load position

Specified by:

goLoadPosition in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

goProbingZoneCentre

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

Description copied from interface: ProbeStation

Moves stage to Probing Zone Centre

Specified by:

goProbingZoneCentre in interface ProbeStation

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device