xal.smf.impl

Class WireHarp.DaqConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireHarp.DaqConfig

All Implemented Interfaces:

java.lang.Cloneable, ProfileDevice.IProfileDomain, DataListener

Enclosing class:

WireHarp

public static class WireHarp.DaqConfig
extends ParameterSet
implements ProfileDevice.IProfileDomain

Class WireHarp.DaqConfig. A data structure containing fields that indicate the status of the data acquisition capabilities. In particular, there are status records for the operation of each wire within each measurement plane (eg., horizontal, vertical, diagonal).

NOTE

· There is a pretty egregious kluge on the attribute DaqConfig.cntWires. The value is hard coded with the constant DaqConfig.CNT_WIRES since there is no way to dynamically acquire this value.

Since:

Apr 11, 2014

Nested Class Summary

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

ScadaRecord.IFieldDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
double[]	arrPosDia Array of wire positions on the beam axis for the diagonal projection plane.
double[]	arrPosHor Array of wire positions on the beam axis for the horizontal projection plane.
double[]	arrPosVer Array of wire positions on the beam axis for the vertical projection plane.
int	cntWires The number of wires within the harp.
int	fitTypeCode Type code of the current fitting profile 0 = Super Gaussian 1 = Super Gaussian × Gaussian 2 = Super Gaussian + Gaussian 3 = Super Gaussian × Parabola
static ScadaFieldMap	FLD_MAP Map of field names to field SCADA descriptors for this structure
int	recWiresDia Bit record indicating operation status for each wire of the diagonal wire set.
int	recWiresHor Bit record indicating operation status for each wire of the horizontal wire set.
int	recWiresVer Bit record indicating operation status for each wire of the vertical wire set.

Constructor Summary

Constructors

Constructor and Description
DaqConfig() Create a new, uninitialized DaqConfig object.
DaqConfig(WireHarp smfHarp) Create a new DaqConfig object containing the status information of the given device.

Method Summary

Modifier and Type	Method and Description
static WireHarp.DaqConfig	acquire(WireHarp smfHarp) Convenience method for retrieving a new initialized data structure populated from the given device state.
double	getInitialPosition(ProfileDevice.ANGLE angle) Return the left-most position of the projection interval, that is, the minimum valued endpoint.
double	getIntervalLength(ProfileDevice.ANGLE angle) Return the length of the real interval containing the projection data.
int	getSampleCount(ProfileDevice.ANGLE angle) Returns the number of signal samples in the profile data, that is, the number of data points in the domain.
double[]	getSamplePositions(ProfileDevice.ANGLE angle) Returns the array of sampling positions for the profile data
boolean	validWire(ProfileDevice.ANGLE ang, int index) Check if the indicated wire is valid, that is, producing valid data.
int	validWireCount(ProfileDevice.ANGLE ang) Returns the number of valid harp wires for the given projection plane.
boolean[]	validWires(ProfileDevice.ANGLE ang) Creates an array of status flags for each harp wire for the given transverse plane.

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 Detail

FLD_MAP

public static final ScadaFieldMap FLD_MAP

Map of field names to field SCADA descriptors for this structure

cntWires

public int cntWires

The number of wires within the harp.

April, 2014: Currently this value must be provided externally as it is not available via the control system.

arrPosHor

@AScada.Field(type=double[].class,
              ctrl=false,
              hndRb="DatHorRawPositions")
public double[] arrPosHor

Array of wire positions on the beam axis for the horizontal projection plane.

arrPosVer

@AScada.Field(type=double[].class,
              ctrl=false,
              hndRb="DatVerRawPositions")
public double[] arrPosVer

Array of wire positions on the beam axis for the vertical projection plane.

arrPosDia

@AScada.Field(type=double[].class,
              ctrl=false,
              hndRb="DatDiaRawPositions")
public double[] arrPosDia

Array of wire positions on the beam axis for the diagonal projection plane.

recWiresHor

@AScada.Field(type=int.class,
              ctrl=false,
              hndRb="StatRecHorWires")
public int recWiresHor

Bit record indicating operation status for each wire of the horizontal wire set.

bolStatus = 2ⁿ & statWireHor

where n=0,1,... is the index of the wire.

Do Not access this field directly!

recWiresVer

@AScada.Field(type=long.class,
              ctrl=false,
              hndRb="StatRecVerWires")
public int recWiresVer

Bit record indicating operation status for each wire of the vertical wire set.

bolStatus = 2ⁿ & statWireVer

where n=0,1,... is the index of the wire.

Do Not access this field directly!

recWiresDia

@AScada.Field(type=int.class,
              ctrl=false,
              hndRb="StatRecDiaWires")
public int recWiresDia

Bit record indicating operation status for each wire of the diagonal wire set.

bolStatus = 2ⁿ & statWireDia

where n=0,1,... is the index of the wire.

Do Not access this field directly!

fitTypeCode

@AScada.Field(type=int.class,
              ctrl=false,
              hndRb="StatFitType")
public int fitTypeCode

Type code of the current fitting profile
0 = Super Gaussian
1 = Super Gaussian × Gaussian
2 = Super Gaussian + Gaussian
3 = Super Gaussian × Parabola

Constructor Detail

DaqConfig

public DaqConfig()

Create a new, uninitialized DaqConfig object.

Since:

Jan 21, 2010

DaqConfig

public DaqConfig(WireHarp smfHarp)
          throws ConnectionException,
                 GetException

Create a new DaqConfig object containing the status information of the given device.

Parameters:

smfHarp - wire harp device under query

Throws:

ConnectionException - unable to connect parameter read back channel

GetException - general field initialization exception

Since:

Jan 21, 2010

Method Detail

acquire

public static WireHarp.DaqConfig acquire(WireHarp smfHarp)
                                  throws ConnectionException,
                                         GetException

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

Parameters:

smfHarp - data acquisition device

Returns:

current set of device status parameters

Throws:

ConnectionException - unable to connect parameter read back channel

GetException - general field initialization exception

Since:

Mar 20, 2014

validWireCount

public int validWireCount(ProfileDevice.ANGLE ang)

Returns the number of valid harp wires for the given projection plane.

Parameters:

ang - projection angle for the harp

Returns:

number of wires producing valid data for the given harp

Since:

Jun 5, 2014

validWire

public boolean validWire(ProfileDevice.ANGLE ang,
                         int index)
                  throws java.lang.IllegalArgumentException

Check if the indicated wire is valid, that is, producing valid data. The given wire index must be in the range [0,N] where N is the number of wires in the harp.

Parameters:

ang - the transverse plane of the profile (i.e., wire set)

index - the index of the wire within the harp

Returns:

true if the indicated wire is working correctly, false otherwise

Throws:

java.lang.IllegalArgumentException - the index provided was not in the correct range

Since:

Apr 14, 2014

validWires

public boolean[] validWires(ProfileDevice.ANGLE ang)

Creates an array of status flags for each harp wire for the given transverse plane. The array size equals the number of wires in the harp (cntWires), the index into the array is the index of the harp wire.

Parameters:

ang - transverse plane of the profile

Returns:

array containing status flags indexed by harp wire

Since:

Apr 14, 2014

getSampleCount

public int getSampleCount(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Returns the number of signal samples in the profile data, that is, the number of data points in the domain.

Specified by:

getSampleCount in interface ProfileDevice.IProfileDomain

Returns:

number of data samples of the given angle

Since:

Apr 24, 2014

See Also:

gov.sns.xal.smf.impl.profile.ProfileDevice.IProfileDomain#getSampleCount(gov.sns.xal.smf.impl.profile.ProfileDevice.ANGLE)

getSamplePositions

public double[] getSamplePositions(ProfileDevice.ANGLE angle)

Returns the array of sampling positions for the profile data

Specified by:

getSamplePositions in interface ProfileDevice.IProfileDomain

Parameters:

angle - the projection angle of the data set

Returns:

sample axis positions of the projection data

Since:

Apr 24, 2014

See Also:

gov.sns.xal.smf.impl.profile.ProfileDevice.IProfileDomain#getSamplePositions(gov.sns.xal.smf.impl.profile.ProfileDevice.ANGLE)

getInitialPosition

public double getInitialPosition(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Return the left-most position of the projection interval, that is, the minimum valued endpoint.

Specified by:

getInitialPosition in interface ProfileDevice.IProfileDomain

Returns:

left endpoint of the projection interval

Since:

Apr 24, 2014

See Also:

gov.sns.xal.smf.impl.profile.ProfileDevice.IProfileDomain#getInitialPosition(gov.sns.xal.smf.impl.profile.ProfileDevice.ANGLE)

getIntervalLength

public double getIntervalLength(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Return the length of the real interval containing the projection data. That is, return the measure of the smallest real interval containing the projection data.

Specified by:

getIntervalLength in interface ProfileDevice.IProfileDomain

Parameters:

angle - the projection angle of the data set

Returns:

length of the interval of definition for the given data set

Since:

Apr 24, 2014

See Also:

gov.sns.xal.smf.impl.profile.ProfileDevice.IProfileDomain#getIntervalLength(gov.sns.xal.smf.impl.profile.ProfileDevice.ANGLE)