Package jisa.devices.interfaces

Interface FMeter

All Superinterfaces:

Instrument

All Known Subinterfaces:

DPLockIn, LockIn

All Known Implementing Classes:

SR830

public interface FMeter
extends Instrument

Standard interface for instrument that provide frequency measurements.

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
default java.util.List<Instrument.Parameter<?>>	getConfigurationParameters(java.lang.Class<?> target)
double	getFrequency()	Returns the frequency value currently being reported by the instrument, in Hz.
double	getFrequencyRange()	Returns the frequency measurement range being used by the instrument, in Hz.
void	setFrequencyRange(double range)	Sets the frequency measurement range to be used by the instrument.

Methods inherited from interface jisa.devices.interfaces.Instrument

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

Method Detail

getFrequency

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

Returns the frequency value currently being reported by the instrument, in Hz.

Returns:

Frequency, in Hz

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon device compatibility error

getFrequencyRange

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

Returns the frequency measurement range being used by the instrument, in Hz. A value of x indicates a range of +/- x.

Returns:

Frequency range, in +/- Hz.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon device compatibility error

setFrequencyRange

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

Sets the frequency measurement range to be used by the instrument. Will select the smallest range option that contains the specified value.

Parameters:

range - Frequency range to use, in Hz.

Throws:

java.io.IOException - Upon communications error

DeviceException - Upon device compatibility error

getConfigurationParameters

default java.util.List<Instrument.Parameter<?>> getConfigurationParameters(java.lang.Class<?> target)

Specified by:

getConfigurationParameters in interface Instrument