Package xal.smf.impl

Class WireScanner.SmplConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireScanner.SmplConfig

All Implemented Interfaces:

Cloneable, DataListener

Enclosing class:

WireScanner

public static class WireScanner.SmplConfig
extends ParameterSet

Data structure containing the sampling parameters for data acquisition.

Since:

Dec 16, 2009

Author:

Christopher K. Allen

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.scada.ScadaRecord

ScadaRecord.IFieldDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
int	sampleRate	The digitizer sampling rate (in Hz)
double	sampleWindow	The sampling window [0.1,2] msec
int	signalGain	The amplifier signal gain {0, 1, 2}
int	signalTimeout	The timeout period for a no-beam exception [20,300] sec

Constructor Summary

Constructors

Constructor	Description
SmplConfig()	Create a new, uninitialized DaqConfig object.
SmplConfig(ProfileDevice ws)	Create a new DaqConfig object initialize with values fetched from the given device.
SmplConfig(DataAdaptor daptSrc)	Create a new DaqConfig object initialized from the given data source.

Method Summary

Modifier and Type	Method	Description
static WireScanner.SmplConfig	acquire(ProfileDevice ws)	Convenience method for retrieving a new initialized data structure populated from the given device state.
ProfileDevice.GAIN	getGain()	Return the gain as a GAIN enumeration.
void	setGain(ProfileDevice.GAIN gain)	Set the gain as a GAIN enumeration.

Methods inherited from class xal.smf.impl.profile.ParameterSet

dataLabel

Methods inherited from class xal.smf.scada.ScadaRecord

clone, getFieldDescriptor, getFieldDescriptorMap, getFieldDescriptors, loadHardwareValues, setFieldFromPV, setHardwareValues, setPvFromField, toString, update, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

sampleRate

@Field(type=int.class,
       ctrl=true,
       hndRb="DaqCfgScanRateRb",
       hndSet="DaqCfgScanRateSet")
public int sampleRate

The digitizer sampling rate (in Hz)

sampleWindow

@Field(type=double.class,
       ctrl=true,
       hndRb="DaqCfgWindowRb",
       hndSet="DaqCfgWindowSet")
public double sampleWindow

The sampling window [0.1,2] msec

signalGain

@Field(type=int.class,
       ctrl=true,
       hndRb="DaqCfgGainRb",
       hndSet="DaqCfgGainSet")
public int signalGain

The amplifier signal gain {0, 1, 2}

signalTimeout

@Field(type=int.class,
       ctrl=true,
       hndRb="DaqCfgTimeoutRb",
       hndSet="DaqCfgTimeoutSet")
public int signalTimeout

The timeout period for a no-beam exception [20,300] sec

Constructor Details

SmplConfig

public SmplConfig()

Create a new, uninitialized DaqConfig object.

Since:

Dec 20, 2009

SmplConfig

public SmplConfig(DataAdaptor daptSrc)

Create a new DaqConfig object initialized from the given data source.

Parameters:

daptSrc - data source containing data structure fields

Since:

Mar 17, 2010

SmplConfig

public SmplConfig(ProfileDevice ws)
           throws ConnectionException,
GetException

Create a new DaqConfig object initialize with values fetched from the given device.

Parameters:

ws - data acquisition device

Throws:

ConnectionException - unable to connect to a parameter read back channel

GetException - general field initialization exception

Since:

Dec 16, 2009

Method Details

acquire

public static WireScanner.SmplConfig acquire(ProfileDevice ws)
                                      throws ConnectionException,
GetException

Convenience method for retrieving a new initialized data structure populated from the given device state.

Parameters:

ws - data acquisition device

Returns:

New data populated structure

Throws:

ConnectionException - unable to connect parameter read back channel

GetException - general field initialization exception

Since:

Dec 16, 2009

setGain

public void setGain(ProfileDevice.GAIN gain)

Set the gain as a GAIN enumeration.

Parameters:

gain - new gain value

Since:

Dec 23, 2009

getGain

public ProfileDevice.GAIN getGain()

Return the gain as a GAIN enumeration.

Returns:

current gain value

Since:

Dec 23, 2009