org.lsst.ccs.drivers.agilent

Class TestWG33250

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.scpi.TestScpi

org.lsst.ccs.drivers.agilent.TestWG33250

public class TestWG33250
extends org.lsst.ccs.drivers.scpi.TestScpi

Program to test the Agilent WG33250 device driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestWG33250.OnOff

Field Summary

Fields inherited from class org.lsst.ccs.drivers.scpi.TestScpi

scpi

Fields inherited from class org.lsst.ccs.drivers.ascii.TestAscii

dev

Constructor Summary

Constructors

Constructor and Description
TestWG33250() Constructor

Method Summary

Modifier and Type	Method and Description
String	getAmplitude() Shows the amplitude.
String	getAmplitude(WG33250.Limit limit) Shows an amplitude limit.
String	getDutyCycle() Shows the square wave duty cycle.
String	getDutyCycle(WG33250.Limit limit) Shows a square wave duty cycle limit.
String	getFrequency() Shows the frequency.
String	getFrequency(WG33250.Limit limit) Shows a frequency limit.
String	getFunction() Shows the function.
String	getHighLevel() Shows the high level.
String	getHighlevel(WG33250.Limit limit) Shows a high level limit.
String	getLowLevel() Shows the low level.
String	getLowlevel(WG33250.Limit limit) Shows a low level limit.
String	getOffset() Shows the offset.
String	getOffset(WG33250.Limit limit) Shows an offset limit.
String	getOutputLoad() Shows the output load.
String	getOutputLoad(WG33250.Limit limit) Shows an output load limit.
String	getPulsePeriod() Shows the pulse period.
String	getPulsePeriod(WG33250.Limit limit) Shows a pulse period limit.
String	getPulseTransition() Shows the pulse transition time.
String	getPulseTransition(WG33250.Limit limit) Shows a pulse transition time limit.
String	getPulseWidth() Shows the pulse width.
String	getPulseWidth(WG33250.Limit limit) Shows a pulse width limit.
String	getSymmetry() Shows the ramp symmetry.
String	getSymmetry(WG33250.Limit limit) Shows a ramp symmetry limit.
String	getUnit() Shows the amplitude unit.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident) Opens connection to a device.
void	setAmplitude(double ampl) Sets the amplitude.
void	setDutyCycle(double cycle) Sets the square wave duty cycle.
void	setFrequency(double freq) Sets the frequency.
void	setFunction(WG33250.Function func) Sets the generator function.
void	setHighLevel(double level) Sets the high level.
void	setLowLevel(double level) Sets the low level.
void	setOffset(double offs) Sets the offset.
void	setOutput(TestWG33250.OnOff state) Turns the output on or off.
void	setOutput(WG33250.Autorange state) Sets the autorange state.
void	setOutputLoad(double load) Sets the output load.
void	setPolarity(WG33250.Polarity value) Sets the polarity.
void	setPulsePeriod(double period) Sets the pulse period.
void	setPulseTransition(double trans) Sets the pulse transition time.
void	setPulseWidth(double width) Sets the pulse width.
void	setSymmetry(double symm) Sets the ramp symmetry.
void	setSyncOutput(TestWG33250.OnOff state) Turns the sync output on or off.
void	setUnit(WG33250.Unit unit) Sets the amplitude unit.
String	showAutorange() Shows the autorange state.
String	showOutput() Shows the output state.
String	showPolarity() Shows the polarity.
String	showSyncOutput() Shows the sync output state.
void	start(WG33250.Function func, double freq, double ampl, double offs) Starts the generator using specified parameters.

Methods inherited from class org.lsst.ccs.drivers.scpi.TestScpi

clear, enableOpc, readDouble, readFloat, readInteger, readString, reset, selfTest, setEse, setSre, showError, showEse, showEsr, showIdentification, showOpc, showSre, showStatus, waitComp, writeCommand

Methods inherited from class org.lsst.ccs.drivers.ascii.TestAscii

close, makeCommandString, open, open, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, read, read, setCmndTerm, setConnTimeout, setDefaultParm, setOptions, setRespTerm, setTerminator, setTimeout, showConnTimeout, showTimeout, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TestWG33250

public TestWG33250()

Constructor

Method Detail

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="type",description="Connection type")
                                                                                         org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                                                                                         @Argument(name="ident",description="Identification")
                                                                                         String ident)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device.

Overrides:

open in class org.lsst.ccs.drivers.ascii.TestAscii

Parameters:

connType - The type of connection: ftdi or serial

ident - The identification: serial no. (ftdi) or port name (serial)

Throws:

org.lsst.ccs.drivers.commons.DriverException

start

@Command(name="start",
         description="Start the generator")
public void start(@Argument(name="function",description="Function name")
                                                                                     WG33250.Function func,
                                                                                     @Argument(name="frequency",description="Frequency (Hz)")
                                                                                     double freq,
                                                                                     @Argument(name="amplitude",description="Amplitude (V)")
                                                                                     double ampl,
                                                                                     @Argument(name="offset",description="Offset (V)")
                                                                                     double offs)
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Starts the generator using specified parameters.

Parameters:

func - The function to use

freq - The frequency

ampl - The amplitude

offs - The offset

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFunction

@Command(name="setfunction",
         description="Set the function")
public void setFunction(@Argument(name="function",description="Function name")
                                                                                              WG33250.Function func)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the generator function.

Parameters:

func - The enumerated function

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFunction

@Command(name="showfunction",
         description="Show the function")
public String getFunction()
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Shows the function.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFrequency

@Command(name="setfrequency",
         description="Set the frequency")
public void setFrequency(@Argument(name="frequency",description="Frequency (Hz)")
                                                                                                 double freq)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Sets the frequency.

Parameters:

freq - The frequency

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFrequency

@Command(name="showfrequency",
         description="Show the frequency")
public String getFrequency()
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Shows the frequency.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFrequency

@Command(name="showfrequency",
         description="Show a frequency limit")
public String getFrequency(@Argument(name="limit",description="Limit name")
                                                                                                         WG33250.Limit limit)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Shows a frequency limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAmplitude

@Command(name="setamplitude",
         description="Set the amplitude")
public void setAmplitude(@Argument(name="amplitude",description="Amplitude (V)")
                                                                                                 double ampl)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Sets the amplitude.

Parameters:

ampl - The amplitude

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAmplitude

@Command(name="showamplitude",
         description="Show the amplitude")
public String getAmplitude()
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Shows the amplitude.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAmplitude

@Command(name="showamplitude",
         description="Show a amplitude limit")
public String getAmplitude(@Argument(name="limit",description="Limit name")
                                                                                                         WG33250.Limit limit)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Shows an amplitude limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOffset

@Command(name="setoffset",
         description="Set the offset")
public void setOffset(@Argument(name="offset",description="Offset (V)")
                                                                                        double offs)
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the offset.

Parameters:

offs - The offset

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOffset

@Command(name="showoffset",
         description="Show the offset")
public String getOffset()
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Shows the offset.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOffset

@Command(name="showoffset",
         description="Show a offset limit")
public String getOffset(@Argument(name="limit",description="Limit name")
                                                                                                WG33250.Limit limit)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows an offset limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setHighLevel

@Command(name="sethighlevel",
         description="Set the high level")
public void setHighLevel(@Argument(name="highlevel",description="High level (V)")
                                                                                                  double level)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets the high level.

Parameters:

level - The level

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHighLevel

@Command(name="showhighlevel",
         description="Show the high level")
public String getHighLevel()
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Shows the high level.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHighlevel

@Command(name="showhighlevel",
         description="Show a high level limit")
public String getHighlevel(@Argument(name="limit",description="Limit name")
                                                                                                          WG33250.Limit limit)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows a high level limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLowLevel

@Command(name="setlowlevel",
         description="Set the low level")
public void setLowLevel(@Argument(name="lowlevel",description="Low level (V)")
                                                                                               double level)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the low level.

Parameters:

level - The level

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLowLevel

@Command(name="showlowlevel",
         description="Show the low level")
public String getLowLevel()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the low level.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLowlevel

@Command(name="showlowlevel",
         description="Show a low level limit")
public String getLowlevel(@Argument(name="limit",description="Limit name")
                                                                                                       WG33250.Limit limit)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows a low level limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setautorange",
         description="Set autorange state")
public void setOutput(@Argument(name="state",description="Autorange state name")
                                                                                                WG33250.Autorange state)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Sets the autorange state.

Parameters:

state - The enumerated state

Throws:

org.lsst.ccs.drivers.commons.DriverException

showAutorange

@Command(name="showautorange",
         description="Show the autorange state")
public String showAutorange()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Shows the autorange state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setUnit

@Command(name="setunit",
         description="Set the amplitude unit")
public void setUnit(@Argument(name="unit",description="Unit name")
                                                                                            WG33250.Unit unit)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the amplitude unit.

Parameters:

unit - The enumerated amplitude unit

Throws:

org.lsst.ccs.drivers.commons.DriverException

getUnit

@Command(name="showunit",
         description="Show the amplitude unit")
public String getUnit()
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the amplitude unit.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDutyCycle

@Command(name="setdutycycle",
         description="Set the square wave duty cycle")
public void setDutyCycle(@Argument(name="dutycycle",description="Duty cycle (%)")
                                                                                                              double cycle)
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the square wave duty cycle.

Parameters:

cycle - The duty cycle

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDutyCycle

@Command(name="showdutycycle",
         description="Show the square wave duty cycle")
public String getDutyCycle()
                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Shows the square wave duty cycle.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDutyCycle

@Command(name="showdutycycle",
         description="Show a square wave duty cycle limit")
public String getDutyCycle(@Argument(name="limit",description="Limit name")
                                                                                                                      WG33250.Limit limit)
                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Shows a square wave duty cycle limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSymmetry

@Command(name="setsymmetry",
         description="Set the ramp symmetry")
public void setSymmetry(@Argument(name="symmetry",description="Symmetry value (%)")
                                                                                                   double symm)
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Sets the ramp symmetry.

Parameters:

symm - The ramp symmetry

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSymmetry

@Command(name="showsymmetry",
         description="Show the ramp symmetry")
public String getSymmetry()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows the ramp symmetry.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSymmetry

@Command(name="showsymmetry",
         description="Show a ramp symmetry limit")
public String getSymmetry(@Argument(name="limit",description="Limit name")
                                                                                                           WG33250.Limit limit)
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Shows a ramp symmetry limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setoutput",
         description="Turn output on or off")
public void setOutput(@Argument(name="state",description="Output state")
                                                                                               TestWG33250.OnOff state)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Turns the output on or off.

Parameters:

state - The state to set (ON or OFF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

@Command(name="showoutput",
         description="Show the output state")
public String showOutput()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the output state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutputLoad

@Command(name="setload",
         description="Set the output load")
public void setOutputLoad(@Argument(name="load",description="Output load (ohms)")
                                                                                               double load)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the output load.

Parameters:

load - The load

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutputLoad

@Command(name="showload",
         description="Show the output load")
public String getOutputLoad()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the output load.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutputLoad

@Command(name="showload",
         description="Show a output load limit")
public String getOutputLoad(@Argument(name="limit",description="Limit name")
                                                                                                       WG33250.Limit limit)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows an output load limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPolarity

@Command(name="setpolarity",
         description="Set the polarity")
public void setPolarity(@Argument(name="polarity",description="Polarity name")
                                                                                              WG33250.Polarity value)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the polarity.

Parameters:

value - The enumerated polarity

Throws:

org.lsst.ccs.drivers.commons.DriverException

showPolarity

@Command(name="showpolarity",
         description="Show the polarity")
public String showPolarity()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the polarity.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSyncOutput

@Command(name="setsync",
         description="Turn sync output on or off")
public void setSyncOutput(@Argument(name="state",description="Sync output state")
                                                                                                      TestWG33250.OnOff state)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Turns the sync output on or off.

Parameters:

state - The state to set (ON or OFF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

showSyncOutput

@Command(name="showsync",
         description="Show the sync output state")
public String showSyncOutput()
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the sync output state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPulsePeriod

@Command(name="setperiod",
         description="Set the pulse period")
public void setPulsePeriod(@Argument(name="period",description="Pulse period")
                                                                                                   double period)
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Sets the pulse period.

Parameters:

period - The period

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulsePeriod

@Command(name="showperiod",
         description="Show the pulse period")
public String getPulsePeriod()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows the pulse period.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulsePeriod

@Command(name="showperiod",
         description="Show a pulse period limit")
public String getPulsePeriod(@Argument(name="limit",description="Limit name")
                                                                                                           WG33250.Limit limit)
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Shows a pulse period limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPulseWidth

@Command(name="setwidth",
         description="Set the pulse width")
public void setPulseWidth(@Argument(name="width",description="Pulse width")
                                                                                                double width)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Sets the pulse width.

Parameters:

width - The pulse width

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulseWidth

@Command(name="showwidth",
         description="Show the pulse width")
public String getPulseWidth()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the pulse width.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulseWidth

@Command(name="showwidth",
         description="Show a pulse width limit")
public String getPulseWidth(@Argument(name="limit",description="Limit name")
                                                                                                        WG33250.Limit limit)
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Shows a pulse width limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPulseTransition

@Command(name="settransition",
         description="Set the pulse transition time")
public void setPulseTransition(@Argument(name="transition",description="Pulse transition")
                                                                                                                    double trans)
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the pulse transition time.

Parameters:

trans - The transition time

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulseTransition

@Command(name="showtransition",
         description="Show the pulse transition time")
public String getPulseTransition()
                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Shows the pulse transition time.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPulseTransition

@Command(name="showtransition",
         description="Show a pulse transition time limit")
public String getPulseTransition(@Argument(name="limit",description="Limit name")
                                                                                                                            WG33250.Limit limit)
                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Shows a pulse transition time limit.

Parameters:

limit - The enumerated limit to show

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException