Package xal.smf.impl

Class WireScanner.DataLivePt

java.lang.Object

xal.smf.impl.profile.SignalSet

xal.smf.impl.WireScanner.DataLivePt

All Implemented Interfaces:

DataListener

Enclosing class:

WireScanner

@ASet(sigHor=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatHorLivePtPositions",hndValRb="DatHorLivePtSignal",hndNseAvgRb="DatHorNoiseAvg",hndNseVarRb="DatHorNoiseStd"),
      sigVer=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatVerLivePtPositions",hndValRb="DatVerLivePtSignal",hndNseAvgRb="DatVerNoiseAvg",hndNseVarRb="DatVerNoiseStd"),
      sigDia=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatDiaLivePtPositions",hndValRb="DatDiaLivePtSignal",hndNseAvgRb="DatDiaNoiseAvg",hndNseVarRb="DatDiaNoiseStd"))
public static class WireScanner.DataLivePt
extends SignalSet

Data structure contain the profile data available during data acquisition in a point-by-point fashion (i.e., as the scan progress).

Since:

Nov 13, 2009

Version:

Mar 05, 2013

Author:

Christopher K. Allen

Field Summary

Fields inherited from class xal.smf.impl.profile.SignalSet

dia, hor, ver

Constructor Summary

Constructors

Constructor	Description
DataLivePt()	Create a new empty DataLive object.
DataLivePt(WireScanner ws)	Create a new DataLive object initialize with values fetched from the given device.
DataLivePt(DataAdaptor daptSrc)	Create a new DataLive object initialized from the given data source.

Method Summary

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

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

average, dataLabel, getDia, getFieldDescriptorList, getFieldDescriptors, getHor, getSignal, getVer, loadHardwareValues, setSignal, toString, update, write

Methods inherited from class java.lang.Object

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

Constructor Details

DataLivePt

public DataLivePt()
           throws ScadaAnnotationException

Create a new empty DataLive object.

Throws:

ScadaAnnotationException - the channel handle annotations are not setup correctly

Since:

Feb 16, 2010

DataLivePt

public DataLivePt(DataAdaptor daptSrc)
           throws ScadaAnnotationException

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

Parameters:

daptSrc - persistent data store containing data structure field values

Throws:

ScadaAnnotationException - the Data AcQ annotations are not setup correctly

Since:

Mar 17, 2010

DataLivePt

public DataLivePt(WireScanner ws)
           throws ConnectionException,
GetException,
ScadaAnnotationException,
BadStructException

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

Parameters:

ws - data acquisition device

Throws:

ScadaAnnotationException - the ASignal.ASet annotations are incomplete

ConnectionException - unable to connect to a parameter read back channel

GetException - general CA GET exception while fetch field value

BadStructException - the DAQ data structure and DAQ channels are incompatible, bad definition

Since:

Nov 14, 2009

Method Details

acquire

public static WireScanner.DataLivePt acquire(WireScanner ws)
                                      throws NoSuchChannelException,
ConnectionException,
GetException,
ScadaAnnotationException,
BadStructException

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:

ScadaAnnotationException - the ASignal.ASet annotations are incomplete

ConnectionException - unable to connect to a parameter read back channel

GetException - general CA GET exception while fetch field value

BadStructException - the DAQ data structure and DAQ channels are incompatible, bad definition

NoSuchChannelException

Since:

Nov 14, 2009