Package xal.smf.impl

Class WireHarp.DevConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireHarp.DevConfig

All Implemented Interfaces:

Cloneable, DataListener

Enclosing class:

WireHarp

public static class WireHarp.DevConfig
extends ParameterSet

Data structure containing the configuration parameters for a WireHarp device. The data structure is active and can be used to set the configuration parameters as well.

Since:

Mar 20, 2014

Author:

Christopher K. Allen

Nested Class Summary

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

ScadaRecord.IFieldDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
int	gainCmn	The (discrete) common amplifier gain for all profile channels.
double	trgDelay	The triggering delay, I think it is in micro-seconds.
int	trgEvent	Triggering event type code.

Constructor Summary

Constructors

Constructor	Description
DevConfig()	Create a new, uninitialized DevConfig object.
DevConfig(WireHarp smHarp)	Create a new ActrConfig object initialize with values fetched from the given device.
DevConfig(DataAdaptor daptSrc)	Create a new DevConfig object initialized from the given data source.

Method Summary

Modifier and Type	Method	Description
static WireHarp.DevConfig	acquire(WireHarp smfHarp)	Returns the defined set of configuration parameters currently used for the given device.
String	dataLabel()	Returns the class name as the DataAdaptor data label.
ProfileDevice.GAIN	getGain()	Return the gain as a GAIN enumeration.
ProfileDevice.TRGEVT	getTriggerEvent()	Converts the trigger event code to the corresponding TRGEVT enumeration constant and returns it.
void	setGain(ProfileDevice.GAIN gain)	Set the gain as a GAIN enumeration.
void	setTriggerEvent(ProfileDevice.TRGEVT evt)	Sets the trigger event code by converting the given TRGEVT enumeration constant to the correct code and assigning the value to the trigger event field in this data structure.

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 Details

gainCmn

@Field(type=int.class,
       ctrl=true,
       hndRb="CfgGainCmnRb",
       hndSet="CfgGainCmnSet")
public int gainCmn

The (discrete) common amplifier gain for all profile channels.
Range = {0, 1, 2}

trgDelay

@Field(type=double.class,
       ctrl=true,
       hndRb="CfgTrgDelayRb",
       hndSet="CfgTrgDelaySet")
public double trgDelay

The triggering delay, I think it is in micro-seconds. This is the delay between the trigger event and the actual data acquisition.

trgEvent

@Field(type=int.class,
       ctrl=true,
       hndRb="CfgTrgEventRb",
       hndSet="CfgTrgEventSet")
public int trgEvent

Triggering event type code.

See Also:

• ProfileDevice.TRGEVT

Constructor Details

DevConfig

public DevConfig()

Create a new, uninitialized DevConfig object.

Since:

Mar 20, 2014

DevConfig

public DevConfig(DataAdaptor daptSrc)

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

Parameters:

daptSrc - data source containing data structure fields

Since:

Mar 20, 2014

DevConfig

public DevConfig(WireHarp smHarp)
          throws ConnectionException,
GetException

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

Parameters:

smHarp - data acquisition device

Throws:

ConnectionException - unable to connect to a parameter channel

GetException - unable to retrieve values from channel access

Since:

Mar 20, 2014

Method Details

acquire

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

Returns the defined set of configuration parameters currently used for the given device.

Parameters:

smfHarp - profile device being queried

Returns:

current configuration for the given device

Throws:

ConnectionException - unable to connect to a parameter read back channel

GetException - general channel access get exception

Since:

Mar 20, 2014

dataLabel

public String dataLabel()

Returns the class name as the DataAdaptor data label.

Specified by:

dataLabel in interface DataListener

Overrides:

dataLabel in class ParameterSet

Returns:

a tag that identifies the receiver's type

Since:

Mar 20, 2014

See Also:

• DataListener.dataLabel()

setGain

public void setGain(ProfileDevice.GAIN gain)

Set the gain as a GAIN enumeration.

Parameters:

gain - new gain value

Since:

Dec 23, 2009

getGain

public ProfileDevice.GAIN getGain()

Return the gain as a GAIN enumeration.

Returns:

current gain value

Since:

Dec 23, 2009

setTriggerEvent

public void setTriggerEvent(ProfileDevice.TRGEVT evt)

Sets the trigger event code by converting the given TRGEVT enumeration constant to the correct code and assigning the value to the trigger event field in this data structure.

Parameters:

evt - enumeration for the desired trigger event code

Since:

Mar 21, 2014

See Also:

• trgEvent

getTriggerEvent

public ProfileDevice.TRGEVT getTriggerEvent()

Converts the trigger event code to the corresponding TRGEVT enumeration constant and returns it.

Returns:

the TRGEVT constant for the current trigger event code

Since:

Mar 21, 2014

See Also:

• trgEvent