Package xal.smf.impl

Class WireHarp

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.profile.ProfileDevice

xal.smf.impl.WireHarp

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class WireHarp
extends ProfileDevice

Wire Harp Hardware

Represents a harp diagnostic device, in particular such a device installed at the SNS facility. The harp has fixed, physical (carbon) wires used to measure the profile of the particle beam. This class implements the device API.

NOTES:

· 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.

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

Since:

Jan 9, 2013

Author:

Christopher K. Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WireHarp.CMD	Wire Scanner Commands
static class	WireHarp.DaqConfig	Class WireHarp.DaqConfig.
static class	WireHarp.DataFit	Structure for maintaining a WireHarp profile data fits.
static class	WireHarp.DataRaw	Structure for maintaining a WireHarp profile data measurement.
static class	WireHarp.DevConfig	Data structure containing the configuration parameters for a WireHarp device.
static class	WireHarp.DevStatus	Contains device status parameters.
static class	WireHarp.FitAttrSet	Data structure containing the profile signal characteristics.

Nested classes/interfaces inherited from class xal.smf.impl.profile.ProfileDevice

ProfileDevice.ANGLE, ProfileDevice.GAIN, ProfileDevice.IProfileData, ProfileDevice.IProfileDomain, ProfileDevice.MACROPULSE, ProfileDevice.MVTVAL, ProfileDevice.TRGEVT

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CNT_WIRES	Kluge - Number of wires on current SNS harps
static final String	HARDWARE_TYPE	Hardware type for the WireHarp class
static final String	SOFTWARE_TYPE	software type for the WireHarp class
static final String	STR_TYPE_ID	The type code for this hardware device

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, strPId

Constructor Summary

Constructors

Constructor	Description
WireHarp(String strId)	Creates a new instance of WireHarp.
WireHarp(String strId, ChannelFactory channelFactory)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
int[]	getCommandResult()	Returns the command result code(s).
String	getSoftType()	Derived class may furnish a unique software type
String	getType()	Get the device type
void	runCommand(WireHarp.CMD cmd)	Issue a wire scanner command with no arguments.

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

acquireConfig, acquireData, configureHardware, createMonitor, testConnection, testConnection

Methods inherited from class xal.smf.AcceleratorNode

addBucket, batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, update, write, writeAttributes, writeStatus

Methods inherited from class java.lang.Object

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

Field Details

STR_TYPE_ID

public static final String STR_TYPE_ID

The type code for this hardware device

See Also:

• Constant Field Values

SOFTWARE_TYPE

public static final String SOFTWARE_TYPE

software type for the WireHarp class

See Also:

• Constant Field Values

HARDWARE_TYPE

public static final String HARDWARE_TYPE

Hardware type for the WireHarp class

See Also:

• Constant Field Values

CNT_WIRES

public static final int CNT_WIRES

Kluge - Number of wires on current SNS harps

See Also:

• Constant Field Values

Constructor Details

WireHarp

public WireHarp(String strId,
 ChannelFactory channelFactory)

Primary Constructor

Parameters:

strId - unique identifier of this node

channelFactory - factory for generating channels for this node

WireHarp

public WireHarp(String strId)

Creates a new instance of WireHarp.

Parameters:

strId -

Since:

Feb 13, 2013

Method Details

getType

public String getType()

Get the device type

Specified by:

getType in class AcceleratorNode

Returns:

The type identifier of this class

getSoftType

public String getSoftType()

Derived class may furnish a unique software type

Overrides:

getSoftType in class AcceleratorNode

Returns:

the "software type" or the driver version for the hardware.

runCommand

public void runCommand(WireHarp.CMD cmd)
                throws PutException,
InterruptedException

Issue a wire scanner command with no arguments.

Parameters:

cmd - wire scanner command

Throws:

ConnectionException - unable to find channel

PutException - unable to set channel value

InterruptedException - command buffer reset thread interrupted

getCommandResult

public int[] getCommandResult()
                       throws GetException

Returns the command result code(s). These are integer valued codes for the result of a previous issued device command. See the wire scanner documentation to interpret the particular resultant code.

Returns:

command result array of integer codes for a command result.

Throws:

ConnectionException - Unable to connect to result readback channel

GetException - Unable to read result from readback channel