xal.smf.impl.profile

Class SignalAttrSet

java.lang.Object

xal.smf.impl.profile.SignalAttrSet

All Implemented Interfaces:

DataListener

Direct Known Subclasses:

WireHarp.FitAttrSet, WireScanner.DblGaussFitAttrSet, WireScanner.GaussFitAttrSet, WireScanner.StatisticalAttrSet

public abstract class SignalAttrSet
extends java.lang.Object
implements DataListener

Data structure containing the signal properties of the the profile data sets acquired from a wire profile device.

Ported from XAL on Jul 15, 2014.
· Jonathan M. Freed

Since:

Feb 23, 2010

Field Summary

Fields

Modifier and Type	Field and Description
SignalAttrs	dia Horizontal wire signal properties
SignalAttrs	hor Horizontal wire signal properties
SignalAttrs	ver Horizontal wire signal properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalAttrSet() Create a new ProfileAttrSet object from the annotation information in the class type.
protected	SignalAttrSet(AcceleratorNode ws) Create a new, initialized ProfileAttrSet object.

Method Summary

Modifier and Type	Method and Description
void	average(SignalAttrSet setAvg, double dblWtFac) Averages all the signal attributes in the signal attributes set using the given weighting factor.
java.lang.String	dataLabel() Label used for parameter set identification.
java.util.List<ScadaFieldDescriptor>	getFieldDescriptors() Returns the set of all SCADA field descriptors describing the data acquisition channels.
SignalAttrs	getSignalAttrs(ProfileDevice.ANGLE angle) Returns the signal attributes of this set corresponding to the give profile angle.
void	setSignalAttrs(ProfileDevice.ANGLE angle, SignalAttrs attrSignal) Sets the signal attribute for the given measurement angle to the given signal attribute object.
void	update(DataAdaptor daptSrc) Load the contents of this signal traits set from the persistent store behind the DataListener interface.
void	write(DataAdaptor adaptor) Write out the contents of this signal traits set to the given data store.

Methods inherited from class java.lang.Object

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

Field Detail

hor

public SignalAttrs hor

Horizontal wire signal properties

ver

public SignalAttrs ver

Horizontal wire signal properties

dia

public SignalAttrs dia

Horizontal wire signal properties

Constructor Detail

SignalAttrSet

protected SignalAttrSet()

Create a new ProfileAttrSet object from the annotation information in the class type.

Since:

Feb 25, 2010

SignalAttrSet

protected SignalAttrSet(AcceleratorNode ws)
                 throws ConnectionException,
                        GetException

Create a new, initialized ProfileAttrSet object.

Parameters:

arrPfdHor - set of process variable descriptors for the horizonal signal

arrPfdVer - set of process variable descriptors for the vertical signal

arrPfdDia - set of process variable descriptors for the diagonal signal

ws - hardware device containing initialization data.

Throws:

ConnectionException - unable to connect to a parameter read back channel

GetException - general CA GET exception while fetch field value

Since:

Feb 25, 2010

Method Detail

getFieldDescriptors

public java.util.List<ScadaFieldDescriptor> getFieldDescriptors()

Returns the set of all SCADA field descriptors describing the data acquisition channels. Since this is an active data structure these channels are used internally to populate the data fields, which is profile data taken from the hardware.

This will work. If the child class has been annotated by ASignal.ASet the Signal attributes will be connected in the zero-argument constructor.

Returns:

set of all channel field descriptors used by this data structure

Since:

Mar 15, 2011

setSignalAttrs

public void setSignalAttrs(ProfileDevice.ANGLE angle,
                           SignalAttrs attrSignal)

Sets the signal attribute for the given measurement angle to the given signal attribute object.

Parameters:

angle - measurement angle of the modified signal attributes

attrSignal - new signal attributes for the given measurement angle

Since:

Apr 23, 2014

getSignalAttrs

public SignalAttrs getSignalAttrs(ProfileDevice.ANGLE angle)

Returns the signal attributes of this set corresponding to the give profile angle.

Parameters:

angle - measurement angle of the desired signal properties

Returns:

signal properties corresponding to the given angle

Since:

Apr 23, 2014

average

public void average(SignalAttrSet setAvg,
                    double dblWtFac)
             throws java.lang.IllegalArgumentException

Averages all the signal attributes in the signal attributes set using the given weighting factor. See SignalSignalAttrs#average(Signal, double) for additional information.

Parameters:

setAvg - signal set to average into this one

dblWtFac - averaging magnitude λ ∈ [0,1]

Throws:

java.lang.IllegalArgumentException - the provided signal is not the same size as this signal

Since:

May 1, 2014

dataLabel

public java.lang.String dataLabel()

Label used for parameter set identification.

Specified by:

dataLabel in interface DataListener

Returns:

string label (identifier) for parameter set

Since:

Mar 4, 2010

See Also:

gov.sns.tools.data.DataListener#dataLabel()

update

public void update(DataAdaptor daptSrc)

Load the contents of this signal traits set from the persistent store behind the DataListener interface.

Specified by:

update in interface DataListener

Parameters:

daptSrc - data source

Since:

Mar 4, 2010

See Also:

gov.sns.tools.data.DataListener#update(gov.sns.tools.data.DataAdaptor)

write

public void write(DataAdaptor adaptor)

Write out the contents of this signal traits set to the given data store.

Specified by:

write in interface DataListener

Parameters:

adaptor - data store exposing DataListener interface

Since:

Mar 4, 2010

See Also:

gov.sns.tools.data.DataListener#write(gov.sns.tools.data.DataAdaptor)