Package jisa.devices.interfaces

Interface ISource

All Superinterfaces:

Instrument, Switch

All Known Subinterfaces:

DCPower, IVSource, MCSMU, SMU

All Known Implementing Classes:

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

public interface ISource
extends Instrument, Switch

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

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
double	getCurrent()	Returns the current being output.
static java.lang.String	getDescription()
boolean	isOn()	Returns whether the current-source is on or off.
void	setCurrent(double current)	Sets the current to output.
void	turnOff()	Turns the current-source off.
void	turnOn()	Turns the current-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()

setCurrent

void setCurrent(double current)
         throws java.io.IOException,
                DeviceException

Sets the current to output.

Parameters:

current - Current to output, in Amps

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

getCurrent

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

Returns the current being output.

Returns:

Current being output, in Amps

Throws:

DeviceException - Upon incompatibility with device

java.io.IOException - Upon communications error

turnOn

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

Turns the current-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 current-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 current-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