Package jisa.devices.interfaces

Interface VSource

All Superinterfaces:

Instrument, Switch

All Known Subinterfaces:

DCPower, IVSource, MCSMU, SMU

All Known Implementing Classes:

AgilentE3644A, AgilentSPA.ASMU, AgilentSPA.AVSU, DummyMCSMU, K1234, K2200, K236, K2400, K2450, K2600B, K6430, KeithleySCPI, MCSMU.VirtualSMU, TestFET, TSX3510P

public interface VSource
extends Instrument, Switch

Interface to define the standard functionality of an instrument that can source voltage.

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	getVoltage()	Returns the voltage being output.
boolean	isOn()	Returns whether the voltage-source is on or off.
void	setVoltage(double voltage)	Set the voltage to output.
void	turnOff()	Turns the voltage-source off.
void	turnOn()	Turns the voltage-source on.

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Methods inherited from interface jisa.devices.interfaces.Switch

setOn

Method Detail

getDescription

static java.lang.String getDescription()

setVoltage

void setVoltage(double voltage)
         throws java.io.IOException,
                DeviceException

Set the voltage to output.

Parameters:

voltage - Voltage to output, in Volts

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getVoltage

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

Returns the voltage being output.

Returns:

Voltage being output, in Volts

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

turnOn

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

Turns the voltage-source on.

Specified by:

turnOn in interface Switch

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

turnOff

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

Turns the voltage-source off.

Specified by:

turnOff in interface Switch

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

isOn

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

Returns whether the voltage-source is on or off.

Specified by:

isOn in interface Switch

Returns:

Is it on?

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error