NB: This manual documents a 20+ year old version of EPICS, see here for the EPICS 7 Record Reference documentation.
EPICS Record Reference Manual
scan parameters
read parameters
operator display parameters
run-time parameters
The DTYP field must contain the name of the appropriate device support module. The user can see a list of the device support modules currently supported at the user's local site by using the dbst
utility (R3.13).
The values retrieved from the input link are placed in an array referenced by VAL. (If the INP link is a constant, elements can be placed in the array via dbPuts.) NELM specifies the number of elements that the array will hold, while FTVL specifies the data type of the elements.
The RARM field causes the device to re-arm when this field is set to 1.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
INP | Input Link | INLINK | Yes | 0 | No | No | N/A | No |
NELM | Number of Elements in array | ULONG | Yes | 1 | Yes | No | No | No |
FTVL | Field Type of Value | GBLCHOICE | Yes | 0 | Yes | No | No | No |
RARM | Rearm | SHORT | Yes | 0 | Yes | Yes | No | Yes |
EGU is a string of up to 16 characters describing the units that the waveform measures. It is retrieved by the get_units
record support routine.
The HOPR and LOPR fields set the upper and lower display limits for array elements referenced by the VAL field. Both the get_graphic_double
and get_control_double
record support routines retrieve these fields.
The PREC field determines the floating point precision with which to display the array values. It is used whenever the get_precision
record support routine is called.
See Chapter 2, Fields Common to All Record Types, for more on the record name (NAME) and description (DESC) fields.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
EGU | Engineering Units | STRING [16] | Yes | null | Yes | Yes | No | No |
HOPR | High Operating Range | FLOAT | Yes | 0 | Yes | Yes | No | No |
LOPR | Low Operating Range | FLOAT | Yes | 0 | Yes | Yes | No | No |
PREC | Display Precision | SHORT | Yes | 0 | Yes | Yes | No | No |
NAME | Record Name | STRING [29] | Yes | 0 | Yes | No | No | No |
DESC | Description | STRING [29] | Yes | Null | Yes | Yes | No | No |
VAL references the array where the waveform stores its data. The BPTR field holds the address of the array.
The NORD field holds a counter of the number of elements that have been read into the array. It is reset to 0 when the device is rearmed. The BUSY field indicates if the device is armed but has not yet been digitized.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
VAL | Value Field | See FTVL | No | 0 | Yes | Yes | Yes | Yes |
BPTR | Buffer Pointer | NOACCESS | No | 0 | No | No | No | No |
NORD | Number of Elements Read | ULONG | No | 0 | Yes | No | No | No |
BUSY | Busy | SHORT | No | 0 | Yes | No | No | No |
The following fields are used to operate the waveform in the simulation mode. See Simulation Mode, Chapter 3, 2.4, for more information on the simulation mode fields.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
SIOL | Simulation Value Location | INLINK | Yes | 0 | No | No | N/A | No |
SIML | Simulation Mode Location | INLINK | Yes | 0 | No | No | N/A | No |
SIMM | Simulation Mode | GBLCHOICE | No | 0 | Yes | Yes | No | No |
SIMS | Simulation Mode Alarm Severity | GBLCHOICE | Yes | 0 | Yes | Yes | No | No |
This routine initializes SIMM with the value of SIML if SIML type is CONSTANT link or creates a channel access link if SIML type is PV_LINK. VAL is likewise initialized if SIOL is CONSTANT or PV_LINK.
This routine next checks to see that device support is available and a device support read routine is defined. If either does not exist, an error message is issued and processing is terminated
If device support includes init_record, it is called.
recGblGetPrec()
.upper_disp_limit = HOPR
lower_disp_limit = LOPR
upper_ctrl_limit = HOPR
lower_ctrl_limit = LOPR
Name | Summary | Description |
---|---|---|
PACT | Processing Active | See Chapter 2, Fields Common to All Record Types for an explanation of these fields. |
DPVT | Device Private | |
NSEV | New Alarm Severity | |
NSTA | New Alarm Status | |
INP | Input Link | This field is used by the device support routines to locate its input. |
RATE | Sampling Rate | Some device support modules may find this useful. |
PTSS | Pre-trigger Samples | Some device support modules may find this useful. |
NELM | Number Of Elements In Array | |
FTVL | Field Type Of Value | This is DBF_STRING, ... , DBF_ENUM. The device support routine should check that this is correctly defined. |
RARM | Rearm | When set to 1, the device will be rearmed. The device support routine should reset it to 0 when done. |
BPTR | Holds Address of Array | |
NORD | Number of Elements Read | Device support must set this value when it completes. |
BUSY | Is device busy? |
report(FILE fp, paddr)Not currently used.
init()This routine is called once during IOC initialization.
init_record(precord)This routine is optional. If provided, it is called by the record support init_record routine.
get_ioint_info(int cmd,struct dbCommon *precord,IOSCANPVT *ppvt)This routine is called by the ioEventScan system each time the record is added or deleted from an I/O event scan list. cmd has the value (0,1) if the record is being (added to, deleted from) an I/O event list. It must be provided for any device type that can use the ioEvent scanner.
read_wf(precord)This routine must provide a new input value. It returns the following values:
0: Success.
Other: Error.
Soft Channel
device support module is provided to read values from other records and store them in arrays. If INP is a constant link, then read_wf does nothing. In this case, the record can be used to hold arrays written via dbPuts. If INP is a database or channel access link, the new array value is read from the link. NORD is set.This module places a value directly in VAL.
If the INP link type is constant, then NORD is set to zero. If the INP link type is PV_LINK, then dbCaAddInlink is called by init_record.
read_wf calls recGblGetLinkValue which performs the following steps:
If the INP link type is CONSTANT recGblGetLinkValue does nothing.
If the INP link type is DB_LINK, then dbGetLink is called to obtain a new input value. If dbGetLink returns an error, a LINK_ALARM with a severity of INVALID_ALARM is raised.
If the INP link type is CA_LINK, then dbCaGetLink is called to obtain a new input value. If dbCaGetLink returns an error, a LINK_ALARM with a severity of INVALID_ALARM is raised.
NORD is set to the number of values returned and read_wf returns.
Generated with Harlequin WebMaker