Package xal.smf.impl

Class WireScanner.PrcgConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireScanner.PrcgConfig

All Implemented Interfaces:

Cloneable, DataListener

Enclosing class:

WireScanner

public static class WireScanner.PrcgConfig
extends ParameterSet

Data structure containing the configuration parameters for the on-board data processing and analysis.

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
double	avgBgn	Time position to start signal averaging
double	avgLng	The size (in time) of the time averaging window
static final ScadaFieldMap	FLD_MAP	Map of field names to SCADA field Descriptors
int	sigInv	Inversion of acquired profile signal {-1,+1}

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WireScanner.PrcgConfig	acquire(ProfileDevice ws)	Convenience method for retrieving a new initialized data structure populated from the given device state.

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

FLD_MAP

public static final ScadaFieldMap FLD_MAP

Map of field names to SCADA field Descriptors

sigInv

@Field(type=int.class,
       ctrl=true,
       hndRb="PrcgCfgInvertRb",
       hndSet="PrcgCfgInvertSet")
public int sigInv

Inversion of acquired profile signal {-1,+1}

avgBgn

@Field(type=double.class,
       ctrl=true,
       hndRb="PrcgCfgAvgBeginRb",
       hndSet="PrcgCfgAvgBeginSet")
public double avgBgn

Time position to start signal averaging

avgLng

@Field(type=double.class,
       ctrl=true,
       hndRb="PrcgCfgAvgLengthRb",
       hndSet="PrcgCfgAvgLengthSet")
public double avgLng

The size (in time) of the time averaging window

Constructor Details

PrcgConfig

public PrcgConfig()

Create a new, uninitialized DaqConfig object.

Since:

Dec 20, 2009

PrcgConfig

public PrcgConfig(DataAdaptor daptSrc)

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

Parameters:

daptSrc - persistent data store containing data structure field values

Since:

Mar 17, 2010

PrcgConfig

public PrcgConfig(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.PrcgConfig 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