Package jisa.devices.interfaces

Interface VPreAmp

All Superinterfaces:

Instrument

All Known Implementing Classes:

SR560

public interface VPreAmp
extends Instrument

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
Coupling	getCoupling()	Returns the coupling configuration currently being used.
static java.lang.String	getDescription()
double	getFilterHighFrequency()	Returns the high frequency value currently being used by the filter.
double	getFilterLowFrequency()	Returns the low frequency value currently being used by the filter.
Filter	getFilterMode()	Returns the filter mode currently being used.
double	getFilterRollOff()	Returns the filter roll-off value currently being used in db/decade
double	getGain()	Returns the gain value of the amplifier currently.
Input	getInput()	Returns the source terminal configuration currently being used.
void	setCoupling(Coupling mode)	Sets the coupling mode of the pre-amplifier.
void	setFilterHighFrequency(double frequency)	Sets the high frequency value of the filter to the given value or as close as possible.
void	setFilterLowFrequency(double frequency)	Sets the low frequency value of the filter to the given value or as close as possible.
void	setFilterMode(Filter mode)	Sets the filter mode of the pre-amplifier.
void	setFilterRollOff(double dbLevel)	Sets the filter roll-off value in db/decade (or as close to it as one can get).
void	setGain(double gain)	Sets the gain to the given value, or as close to it as possible.
void	setInput(Input source)	Sets the source terminal to use, either A, B or DIFF (for A - B).

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Method Detail

getDescription

static java.lang.String getDescription()

setGain

void setGain(double gain)
      throws java.io.IOException,
             DeviceException

Sets the gain to the given value, or as close to it as possible.

Parameters:

gain - Gain value

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setInput

void setInput(Input source)
       throws java.io.IOException,
              DeviceException

Sets the source terminal to use, either A, B or DIFF (for A - B).

Parameters:

source - Source terminal configuration

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setCoupling

void setCoupling(Coupling mode)
          throws java.io.IOException,
                 DeviceException

Sets the coupling mode of the pre-amplifier.

Parameters:

mode - Coupling mode: GROUND, DC or AC.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setFilterMode

void setFilterMode(Filter mode)
            throws java.io.IOException,
                   DeviceException

Sets the filter mode of the pre-amplifier.

Parameters:

mode - Filter-mode: NONE, LOW_PASS, HIGH_PASS or BAND_PASS

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setFilterRollOff

void setFilterRollOff(double dbLevel)
               throws java.io.IOException,
                      DeviceException

Sets the filter roll-off value in db/decade (or as close to it as one can get).

Parameters:

dbLevel - Roll-off (db/decade)

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setFilterHighFrequency

void setFilterHighFrequency(double frequency)
                     throws java.io.IOException,
                            DeviceException

Sets the high frequency value of the filter to the given value or as close as possible.

Parameters:

frequency - High frequency value, in Hz

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

setFilterLowFrequency

void setFilterLowFrequency(double frequency)
                    throws java.io.IOException,
                           DeviceException

Sets the low frequency value of the filter to the given value or as close as possible.

Parameters:

frequency - Low frequency value, in Hz

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getGain

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

Returns the gain value of the amplifier currently.

Returns:

Gain value

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getInput

Input getInput()
        throws java.io.IOException,
               DeviceException

Returns the source terminal configuration currently being used.

Returns:

Source terminal configuration

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getCoupling

Coupling getCoupling()
              throws java.io.IOException,
                     DeviceException

Returns the coupling configuration currently being used.

Returns:

Coupling configuration

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getFilterMode

Filter getFilterMode()
              throws java.io.IOException,
                     DeviceException

Returns the filter mode currently being used.

Returns:

Filter mode

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getFilterRollOff

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

Returns the filter roll-off value currently being used in db/decade

Returns:

Filter roll off (db/decade)

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getFilterHighFrequency

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

Returns the high frequency value currently being used by the filter.

Returns:

High frequency value, in Hz.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error

getFilterLowFrequency

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

Returns the low frequency value currently being used by the filter.

Returns:

Low frequency value, in Hz.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon compatibility error