Package xal.smf.impl

Class WireHarp.DevStatus

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireHarp.DevStatus

All Implemented Interfaces:

Cloneable, DataListener

Enclosing class:

WireHarp

public static class WireHarp.DevStatus
extends ParameterSet

Contains device status parameters.

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	cmdResult	Result code of the latest harp user command.
static final ScadaFieldMap	FLD_MAP	Map of field names to field SCADA descriptors for this structure
int	hrpIns	Flag indicating harp is inserted
int	hrpRetr	Flag indicating harp is retracted
int	hrpStop	Flag indicating harp is stopped
int	statCtrl	Manual control status indicator
int	statDev	Alarm flag for wire signal; it indicates correct operations.
int	statMps	Machine Protection System status flag

Constructor Summary

Constructors

Constructor	Description
DevStatus()	Create a new DevStatus object.
DevStatus(WireHarp smfHarp)	Create a new DevStatus object containing the status information of the given device.

Method Summary

Modifier and Type	Method	Description
static WireHarp.DevStatus	acquire(WireHarp smfHarp)	Convenience method for retrieving a new initialized data structure populated from the given device state.

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

FLD_MAP

public static final ScadaFieldMap FLD_MAP

Map of field names to field SCADA descriptors for this structure

statDev

@Field(type=int.class,
       ctrl=false,
       hndRb="StatDevStatus")
public int statDev

Alarm flag for wire signal; it indicates correct operations.

status: 0=OK, 1=Saturated

statMps

@Field(type=int.class,
       ctrl=false,
       hndRb="StatMpsStatus")
public int statMps

Machine Protection System status flag

statCtrl

@Field(type=int.class,
       ctrl=false,
       hndRb="StatCtrlStatus")
public int statCtrl

Manual control status indicator

hrpIns

@Field(type=int.class,
       ctrl=false,
       hndRb="StatHarpInsert")
public int hrpIns

Flag indicating harp is inserted

hrpRetr

@Field(type=int.class,
       ctrl=false,
       hndRb="StatHarpRetract")
public int hrpRetr

Flag indicating harp is retracted

hrpStop

@Field(type=int.class,
       ctrl=false,
       hndRb="StatHarpStop")
public int hrpStop

Flag indicating harp is stopped

cmdResult

@Field(type=int.class,
       ctrl=false,
       hndRb="StatCmdResult")
public int cmdResult

Result code of the latest harp user command.

Constructor Details

DevStatus

public DevStatus()

Create a new DevStatus object.

Since:

Jan 21, 2010

DevStatus

public DevStatus(WireHarp smfHarp)
          throws ConnectionException,
GetException

Create a new DevStatus 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 Details

acquire

public static WireHarp.DevStatus 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