xal.smf.impl

Class WireScanner.Trace

java.lang.Object

xal.smf.impl.profile.SignalSet

xal.smf.impl.WireScanner.Trace

All Implemented Interfaces:

DataListener

Enclosing class:

WireScanner

@ASignal.ASet(sigHor=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatHorTracePositions",hndValRb="DatHorTraceSignal"),
              sigVer=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatVerTracePositions",hndValRb="DatVerTraceSignal"),
              sigDia=@ASignal(hndCntRb="ScanCfgStepCntRb",hndPosRb="DatDiaTracePositions",hndValRb="DatDiaTraceSignal"))
public static class WireScanner.Trace
extends SignalSet

Data structure containing the last available raw data trace as defined by the sample rate and duration.

Since:

Nov 13, 2009

Field Summary

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

dia, hor, ver

Constructor Summary

Constructors

Constructor and Description
Trace() Creates a new DataTrace object.
Trace(DataAdaptor daptSrc) Create a new DataTrace object initialized from the given data source.

Method Summary

Modifier and Type	Method and Description
static WireScanner.Trace	acquire(WireScanner ws) Convenience method for retrieving a new initialized data structure populated from the given device state.
void	update(DataAdaptor adaptor) Load the data structure fields from the given data source.
void	write(DataAdaptor adaptor) Save the data structure field values to the given data sink.

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

average, dataLabel, getFieldDescriptorList, getFieldDescriptors, getSignal, loadHardwareValues, setSignal, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Trace

public Trace()
      throws ScadaAnnotationException

Creates a new DataTrace object.

Throws:

ScadaAnnotationException - the ASignal.ASet annotations are incomplete

Since:

Feb 26, 2010

Trace

public Trace(DataAdaptor daptSrc)
      throws ScadaAnnotationException

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

Parameters:

daptSrc - persistent data store containing data structure field values

Throws:

ScadaAnnotationException - the ASignal.ASet annotations are incomplete

Since:

Mar 17, 2010

Method Detail

acquire

public static WireScanner.Trace acquire(WireScanner ws)
                                 throws 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

Since:

Nov 14, 2009

update

public void update(DataAdaptor adaptor)

Load the data structure fields from the given data source.

Specified by:

update in interface DataListener

Overrides:

update in class SignalSet

Parameters:

adaptor - data source

Since:

Jun 9, 2010

See Also:

xal.smf.impl.WireScanner2.Data#update(xal.tools.data.DataAdaptor)

write

public void write(DataAdaptor adaptor)

Save the data structure field values to the given data sink.

Specified by:

write in interface DataListener

Overrides:

write in class SignalSet

Parameters:

adaptor - data store exposing DataListener interface

Since:

Jun 9, 2010

See Also:

xal.smf.impl.WireScanner2.Data#write(xal.tools.data.DataAdaptor)