Package jisa.devices.temperature

Class MercuryITC.AuxOutput

java.lang.Object

jisa.devices.temperature.MercuryITC.AuxOutput

All Implemented Interfaces:

Instrument, PID.Output

Enclosing class:

MercuryITC

public class MercuryITC.AuxOutput
extends java.lang.Object
implements PID.Output

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

Constructor Summary

Constructors

Constructor	Description
AuxOutput(java.lang.String uid)

Method Summary

Modifier and Type	Method	Description
Address	getAddress()	Returns any Address object used to connect to this instrument.
java.lang.String	getIDN()	Returns an identifying String of the instrument.
double	getLimit()	Returns the limit/range currently being applied to the output value.
java.lang.String	getName()	Returns the name of the output.
java.lang.String	getUnits()	Returns the units (if any) of the output quantity.
double	getValue()	Returns the value this output is currently outputting.
java.lang.String	getValueName()	Returns the name of the output quantity.
void	setLimit(double range)	Sets the limit/range to apply to the output value.

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

getConfigurationParameters, getConfigurationParameters, getLockObject, setTimeout

Methods inherited from interface jisa.devices.interfaces.PID.Output

close

Constructor Detail

AuxOutput

public AuxOutput(java.lang.String uid)

Method Detail

getIDN

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

Description copied from interface: Instrument

Returns an identifying String of the instrument.

Specified by:

getIDN in interface Instrument

Returns:

Identifying String

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon incompatibility with device

getAddress

public Address getAddress()

Description copied from interface: Instrument

Returns any Address object used to connect to this instrument.

Specified by:

getAddress in interface Instrument

Returns:

Address object, null if none

getValue

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

Description copied from interface: PID.Output

Returns the value this output is currently outputting.

Specified by:

getValue in interface PID.Output

Returns:

Value being output

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getLimit

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

Description copied from interface: PID.Output

Returns the limit/range currently being applied to the output value.

Specified by:

getLimit in interface PID.Output

Returns:

Output limit

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setLimit

public void setLimit(double range)
              throws java.io.IOException,
                     DeviceException

Description copied from interface: PID.Output

Sets the limit/range to apply to the output value.

Specified by:

setLimit in interface PID.Output

Parameters:

range - Output limit/range

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getName

public java.lang.String getName()

Description copied from interface: PID.Output

Returns the name of the output.

Specified by:

getName in interface Instrument

Specified by:

getName in interface PID.Output

Returns:

Output name

getValueName

public java.lang.String getValueName()

Description copied from interface: PID.Output

Returns the name of the output quantity.

Specified by:

getValueName in interface PID.Output

Returns:

Output quantity name

getUnits

public java.lang.String getUnits()

Description copied from interface: PID.Output

Returns the units (if any) of the output quantity.

Specified by:

getUnits in interface PID.Output

Returns:

Output quantity units