Package xal.smf.impl

Class WireScanner.ActrConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireScanner.ActrConfig

All Implemented Interfaces:

Cloneable, DataListener

Enclosing class:

WireScanner

public static class WireScanner.ActrConfig
extends ParameterSet

This class is a data structure for managing scan actuator configuration data parameters.

Since:

Nov 9, 2009

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
double	accelInit	The maximum acceleration of the actuator used to move into the initial scan location; that is, the time derivative of velInit.
double	accelReturn	The maximum actuator acceleration when returning to the home location, in mm/sec.
double	accelSearch	The maximum acceleration used by the actuator when searching for a limit switch, in mm/sec2.
double	accelStep	The maximum acceleration of the actuator used to move between sampling points, in mm/sec2.
double	tmoSearch	The maximum time allowed while the actuator is searching for a limit switch, in seconds.
double	tmoStep	The maximum time allowed to move the actuator between sampling locations, in seconds.
double	velInit	The initial (actuator) speed of the actuator in mm/sec.
double	velReturn	The maximum actuator speed when returning to the home location, in mm/sec.
double	velSearch	The maximum velocity used by the actuator when searching for a limit switch, in mm/sec.
double	velStep	The maximum actuator velocity between sampling points, in mm/sec.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WireScanner.ActrConfig	aquire(ProfileDevice ws)	Return the set of current device configuration parameters.

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 Details

velInit

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgInitSpeedRb",
       hndSet="ActrCfgInitSpeedSet")
public double velInit

The initial (actuator) speed of the actuator in mm/sec. This is the maximum speed obtained by the actuator en route to the location where the data acquisition begins.

accelInit

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgInitAccelRb",
       hndSet="ActrCfgInitAccelSet")
public double accelInit

The maximum acceleration of the actuator used to move into the initial scan location; that is, the time derivative of velInit. The units are mm/sec².

velStep

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgStepSpeedRb",
       hndSet="ActrCfgStepSpeedSet")
public double velStep

The maximum actuator velocity between sampling points, in mm/sec.

accelStep

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgStepAccelRb",
       hndSet="ActrCfgStepAccelSet")
public double accelStep

The maximum acceleration of the actuator used to move between sampling points, in mm/sec². That is, the time derivative of velStep.

velSearch

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgSearchSpeedRb",
       hndSet="ActrCfgSearchSpeedSet")
public double velSearch

The maximum velocity used by the actuator when searching for a limit switch, in mm/sec.

accelSearch

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgSearchAccelRb",
       hndSet="ActrCfgSearchAccelSet")
public double accelSearch

The maximum acceleration used by the actuator when searching for a limit switch, in mm/sec².

velReturn

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgReturnSpeedRb",
       hndSet="ActrCfgReturnSpeedSet")
public double velReturn

The maximum actuator speed when returning to the home location, in mm/sec.

accelReturn

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgReturnAccelRb",
       hndSet="ActrCfgReturnAccelSet")
public double accelReturn

The maximum actuator acceleration when returning to the home location, in mm/sec.

tmoSearch

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgSearchTimeoutRb",
       hndSet="ActrCfgSearchTimeoutSet")
public double tmoSearch

The maximum time allowed while the actuator is searching for a limit switch, in seconds.

tmoStep

@Field(type=double.class,
       ctrl=true,
       hndRb="ActrCfgStepTimeoutRb",
       hndSet="ActrCfgStepTimeoutSet")
public double tmoStep

The maximum time allowed to move the actuator between sampling locations, in seconds.

Constructor Details

ActrConfig

public ActrConfig()

Create a new, uninitialized ActrConfig object.

Since:

Nov 13, 2009

ActrConfig

public ActrConfig(DataAdaptor daptSrc)

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

Parameters:

daptSrc - data source containing data structure fields

Since:

Mar 17, 2010

ActrConfig

public ActrConfig(ProfileDevice ws)
           throws ConnectionException,
GetException

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

Parameters:

ws - data acquisition device

Throws:

ConnectionException - unable to connect to a parameter channel

GetException - unable to retrieve values from channel access

Since:

Dec 16, 2009

Method Details

aquire

public static WireScanner.ActrConfig aquire(ProfileDevice ws)
                                     throws ConnectionException,
GetException

Return the set of current device configuration parameters.

Parameters:

ws - profile device under request

Returns:

configuration for given profile device

Throws:

ConnectionException - unable to connect to a parameter read back channel

GetException - general channel access get exception

Since:

Nov 9, 2009