epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Cleanup of POD documentation, unifying some things

Browse Source 
Incomplete, still lots to do in these files.
This commit is contained in:
Andrew Johnson
2019-10-20 00:41:50 -05:00
parent 00334c981c
commit 178d5779a2
17 changed files with 111 additions and 984 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/std/rec/aiRecord.dbd.pod
View File

@@ -4,7 +4,7 @@
# Copyright (c) 2002 The Regents of the University of California, as
# Operator of Los Alamos National Laboratory.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
# in file LICENSE that is included with this distribution.
#*************************************************************************
=title Analog Input Record (ai)
@@ -214,7 +214,7 @@ monitoring functionality.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_DOUBLE) {
prompt("Current EGU Value")
promptgroup("40 - Input")
@@ -520,7 +520,7 @@ The individual routines are described below.
=head3 Device Support Routines
=head4 long report(int level)
long report(int level)
This optional routine is called by the IOC command C<dbior> and is passed the
report level that was requested by the user.
@@ -530,7 +530,7 @@ information at higher levels, or to select different types of information with
different levels.
Level zero should print no more than a small summary.
=head4 long init(int after)
long init(int after)
This optional routine is called twice at IOC initialization time.
The first call happens before any of the C<init_record()> calls are made, with
@@ -538,7 +538,7 @@ the integer parameter C<after> set to 0.
The second call happens after all of the C<init_record()> calls have been made,
with C<after> set to 1.
=head4 long init_record(aiRecord *prec)
long init_record(aiRecord *prec)
This optional routine is called by the record initialization code for each ai
record instance that has its DTYP field set to use this device support.
@@ -555,7 +555,7 @@ C<LINEAR>, but it is not necessary to check that condition first.
This same calculation takes place in the C<special_linconv()> routine, so the
implementation can usually just call that routine to perform the task.
=head4 long get_ioint_info(int cmd, aiRecord *prec, IOSCANPVT *piosl)
long get_ioint_info(int cmd, aiRecord *prec, IOSCANPVT *piosl)
This optional routine is called whenever the record's SCAN field is being
changed to or from the value C<I/O Intr> to find out which I/O Interrupt Scan
@@ -584,7 +584,7 @@ thread.
The C<scanIoRequest()> routine is safe to call from an interrupt service routine
on embedded architectures (vxWorks and RTEMS).
=head4 long read_ai(aiRecord *prec)
long read_ai(aiRecord *prec)
This essential routine is called when the record wants a new value from the
addressed device.
@@ -595,7 +595,7 @@ It is responsible for performing (or at least initiating) a read operation, and
... return value ...
=head4 long special_linconv(aiRecord *prec, int after)
long special_linconv(aiRecord *prec, int after)
This optional routine should be provided if the record type's unit conversion
features are used by the device support's C<read_ai()> routine returning a

34
src/std/rec/biRecord.dbd.pod
View File

@@ -162,7 +162,7 @@ these fields.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(INP,DBF_INLINK) {
prompt("Input Specification")
promptgroup("40 - Input")
@@ -264,7 +264,7 @@ these fields.
=head3 Record Support Routines
=head2 C<init_record>
long init_record(struct dbCommon *precord, int pass);
This routine initializes SIMM with the value of SIML if SIML type is a
CONSTANT link or creates a channel access link if SIML type is PV_LINK.
@@ -276,19 +276,19 @@ processing is terminated.
If device support includes C<init_record()>, it is called.
=head2 C<process>
long process(struct dbCommon *precord);
See next section.
See L<Record Processing> below.
=head2 C<get_enum_str>
long get_enum_str(const struct dbAddr *paddr, char *pbuffer);
Retrieves ASCII string corresponding to VAL.
=head2 C<get_enum_strs>
long get_enum_strs(const struct dbAddr *paddr, struct dbr_enumStrs *p);
Retrieves ASCII strings for ZNAM and ONAM.
=head2 C<put_enum_str>
long put_enum_str(const struct dbAddr *paddr, const char *pbuffer);
Check if string matches ZNAM or ONAM, and if it does, sets VAL.
@@ -296,7 +296,7 @@ Check if string matches ZNAM or ONAM, and if it does, sets VAL.
Routine process implements the following algorithm:
=over 1
=over
=item 1.
Check to see that the appropriate device support module exists. If it
@@ -317,7 +317,7 @@ Convert.
=back
=over 1
=over
=item *
status = read_bi
@@ -336,7 +336,7 @@ if status is 2, set status = 0
=back
=over 1
=over
=item 5.
Check alarms: This routine checks to see if the new VAL causes the alarm
@@ -348,7 +348,7 @@ Check if monitors should be invoked:
=back
=over 1
=over
=item *
Alarm monitors are invoked if the alarm status or severity has changed.
@@ -364,7 +364,7 @@ NSEV and NSTA are reset to 0.
=back
=over 1
=over
=item 7.
Scan forward link if necessary, set PACT FALSE, and return.
@@ -386,7 +386,7 @@ support routines are primarily interested in the following fields:
Device support consists of the following routines:
=head4 long report(int level)
long report(int level);
This optional routine is called by the IOC command C<dbior> and is passed the
report level that was requested by the user.
@@ -396,7 +396,7 @@ information at higher levels, or to select different types of information with
different levels.
Level zero should print no more than a small summary.
=head4 long init(int after)
long init(int after);
This optional routine is called twice at IOC initialization time.
The first call happens before any of the C<init_record()> calls are made, with
@@ -404,19 +404,19 @@ the integer parameter C<after> set to 0.
The second call happens after all of the C<init_record()> calls have been made,
with C<after> set to 1.
=head2 C<init_record(precord)>
long init_record(struct dbCommon *precord);
This routine is optional. If provided, it is called by the record support
C<init_record()> routine.
=head2 C<get_ioint_info(int cmd, struct dbCommon *precord, IOSCANPVT *ppvt)>
long 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. C<cmd> has the value (0,1) if
the record is being (added to, deleted from) and I/O event list. It must be
provided for any device type that can use the ioEvent scanner.
=head2 C<read_bi(precord)>
long read_bi(struct dbCommon *precord);
This routine must provide a new input value. It returns the following
values:

97
src/std/rec/compressRecord.dbd.pod
View File

@@ -4,7 +4,7 @@
# Copyright (c) 2002 The Regents of the University of California, as
# Operator of Los Alamos National Laboratory.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
# in file LICENSE that is included with this distribution.
#*************************************************************************
=title Compression Record (compress)
@@ -35,46 +35,10 @@ menu(compressALG) {
}
recordtype(compress) {
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scanning Parameters>
=item * L<Algorithms and Related Parameters>
=item * L<Operator Display Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scanning Parameters
The compression record has the standard fields for specifying under what
@@ -232,80 +196,52 @@ SPTR points to an array that is used for array averages.
WPTR is used by the dbGetlinks routines.
=begin html
<br>
<hr>
<br>
=end html
=head2 Record Support
=head3 Record Support Routines (compressRecord.c)
=head3 Record Support Routines
=head4 init_record
long (*init_record)(struct dbCommon *precord, int pass)
long init_record(struct dbCommon *precord, int pass)
Space for all necessary arrays is allocated. The addresses are stored in the
appropriate fields in the record.
=head4 process
long process(struct dbCommon *precord)
long (*process)(struct dbCommon *precord)
See L<Record Processing> below.
See L<Record Processing>
=head4 special
long (*special)(struct dbAddr *paddr, int after)
long special(struct dbAddr *paddr, int after)
This routine is called when RSET, ALG, or N are set. It performs a reset.
=head4 cvt_dbaddr
long (*cvt_dbaddr)(struct dbAddr *paddr)
long cvt_dbaddr(struct dbAddr *paddr)
This is called by dbNameToAddr. It makes the dbAddr structure refer to the
actual buffer holding the result.
=head4 get_array_info
long (*get_array_info)(struct dbAddr *paddr, long *no_elements, long *offset)
long get_array_info(struct dbAddr *paddr, long *no_elements, long *offset)
Obtains values from the circular buffer referenced by VAL.
=head4 put_array_info
long (*put_array_info)(struct dbAddr *paddr, long nNew);
long put_array_info(struct dbAddr *paddr, long nNew);
Writes values into the circular buffer referenced by VAL.
=head4 get_units
long (*get_units)(struct dbAddr *paddr, char *units);
long get_units(struct dbAddr *paddr, char *units);
Retrieves EGU.
=head4 get_precision
long (*get_precision)(const struct dbAddr *paddr, long *precision);
long get_precision(const struct dbAddr *paddr, long *precision);
Retrieves PREC.
=head4 get_graphic_double
long (*get_graphic_double)(struct dbAddr *paddr, struct dbr_grDouble *p);
long get_graphic_double(struct dbAddr *paddr, struct dbr_grDouble *p);
Sets the upper display and lower display limits for a field. If the field is
VAL, the limits are set to HOPR and LOPR, else if the field has upper and lower
limits defined they will be used, else the upper and lower maximum values for
the field type will be used.
=head4 get_control_double
long (*get_control_double)(struct dbAddr *paddr, struct dbr_ctrlDouble *p);
long get_control_double(struct dbAddr *paddr, struct dbr_ctrlDouble *p);
Sets the upper control and the lower control limits for a field. If the field is
VAL, the limits are set to HOPR and LOPR, else if the field has upper and lower
@@ -391,7 +327,7 @@ Scan forward link if necessary, set PACT FALSE, and return.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_NOACCESS) {
prompt("Value")
asl(ASL0)
@@ -515,4 +451,3 @@ Scan forward link if necessary, set PACT FALSE, and return.
interest(3)
}
}

80
src/std/rec/longinRecord.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 Long Input Record (longin)
=title Long Input Record (longin)
The normal use for the long input record or "longin" record is to retrieve a
long integer value of up to 32 bits. Device support routines are provided to
@@ -15,56 +15,6 @@ support direct interfaces to hardware. In addition, the C<<< Soft Channel >>>
device module is provided to obtain input via database or channel access links
or via dbPutField or dbPutLink requests.
=head1 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br><hr><br>
=end html
=recordtype longin
=cut
@@ -73,21 +23,7 @@ recordtype(longin) {
=head2 Parameter Fields
The fields in this record fall into the following categories:
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -174,17 +110,11 @@ See L<Fields Common to Many Record Types> for more information on these fields.
=fields SIOL, SVAL, SIML, SIMM, SIMS
=begin html
<br><hr><br>
=end html
=head2 Record Support
=head3 Record Support Routines
=head3 Record Support Routines
=head4 init_record
=head4 init_record
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. SVAL is likewise
@@ -374,7 +304,7 @@ sets UDF to FALSE. read_longin returns the status of C<recGblGetLinkValue>.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_LONG) {
prompt("Current value")
promptgroup("40 - Input")

64
src/std/rec/longoutRecord.dbd.pod
View File

@@ -7,69 +7,15 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 B<Long Output Record (longout)>
=title Long Output Record (longout)
The normal use for the long output or "longout" record type is to store long
integer values of up to 32 bits and write them to hardware devices. The C<<<
Soft Channel >>> device support routine can also be used to write values to
integer values of up to 32 bits and write them to hardware devices. The C<<<
Soft Channel >>> device support layer can also be used to write values to
other records via database or channel access links. The OUT field determines how
the record is used. The record supports alarm limits and graphics and control
limits.
=head1 L<Contents>
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Desired Output Parameters>
=item * L<Write Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Monitor Parameters>
=item * L<Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br><hr><br>
=end html
=recordtype longout
=cut
@@ -149,7 +95,7 @@ and database links.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_LONG) {
prompt("Desired Output")
promptgroup("50 - Output")
@@ -243,7 +189,7 @@ HYST field contains the alarm deadband around each limit alarm.
See the See L<Alarm Specification> for a complete explanation of alarms and
these fields. For an explanation of the IVOA and IVOV fields, see L<Output
Records>. L<Alarm Fields> lists other fields related to a alarms that are common
to all record types.
to all record types.
=fields HIHI, HIGH, LOW, LOLO, HHSV, HSV, LSV, LLSV, HYST, IVOA, IVOV

84
src/std/rec/mbbiDirectRecord.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 B<Multi-Bit Binary Input Direct Record (mbbiDirect)>
=title Multi-Bit Binary Input Direct Record (mbbiDirect)
The mbbiDirect record retrieves a sixteen-bit hardware value and converts it to
an array of sixteen unsigned characters, each representing a bit of the word.
@@ -17,60 +17,6 @@ This record's operation is similar to that of the multi-bit binary input record,
and it has many fields in common with it. This record also has two available
soft device support modules: C<Soft Channel> and C<Raw Soft Channel>.
=head1 L<Contents>
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Desired Output Parameters>
=item * L<Write Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Monitor Parameters>
=item * L<Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br><hr><br>
=end html
=recordtype mbbiDirect
=cut
@@ -79,23 +25,7 @@ recordtype(mbbiDirect) {
=head2 Parameter Fields
The fields fall into the following categories:
=over
=item * L<Scan Parameters>
=item * L<Read and Convert Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
=cut
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -105,8 +35,6 @@ Fields>. In addition, L<Scanning Specification> explains how these fields are
used. Note that I/O event scanning is only supported for those card types
that interrupt.
=cut
=head3 Read and Convert Parameters
The device support routines obtain the record's input from the device or link
@@ -144,8 +72,6 @@ Each of the fields, B0-BF, represents one bit of the word.
=fields VAL, INP, RVAL, SHFT, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, BA, BB, BC, BD, BE, BF
=cut
=head3 Operator Display Parameters
These parameters are used to present meaningful data to the operator.
@@ -339,12 +265,6 @@ record types.
interest(1)
}
=begin html
<br><hr><br>
=end html
=head2 Record Support
=head3 Record Support Routines

96
src/std/rec/mbbiRecord.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 B<Multi-Bit Binary Input Record (mbbi)>
=title Multi-Bit Binary Input Record (mbbi)
The normal use for the multi-bit binary input record is to read contiguous,
multiple bit inputs from hardware. The binary value represents a state from a
@@ -25,58 +25,6 @@ are provided: C<<< Soft Channel >>> allows VAL to be an arbitrary unsigned short
integer. C<<< Raw Soft Channel >>> reads the value into RVAL just like normal
device support modules.
=head1 L<Contents>
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read and Convert Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time Parameters>
=item * L<Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br><hr><br>
=end html
=recordtype mbbi
=cut
@@ -85,23 +33,7 @@ recordtype(mbbi) {
=head2 Parameter Fields
The multi-bit binary input fields fall into the following categories:
=over
=item * L<Scan Parameters>
=item * L<Read and Convert Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time Parameters>
=item * L<Simulation Mode Parameters>
=back
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -121,7 +53,7 @@ differs according to the I/O bus used. See L<Address Specification> for
information on the format of hardware addresses.
Two soft device support modules can be specified in DTYP C<Soft Channel> and
C<<< Raw Soft Channel >>>.
C<<< Raw Soft Channel >>>.
C<<< Raw Soft Channel >>> reads the value into RVAL,
upon which the normal conversion process is undergone. C<<< Soft Channel >>>
@@ -165,7 +97,7 @@ Each of the fields, ZRVL-FFVL, represents one of the possible sixteen states
Alternatively, the input value can be read as a string, in which case, a match
is sought with one of the strings specified in the ZRST-FFST fields. Then RVAL
is set equal to the corresponding value for that string, and the conversion
process occurs.
process occurs.
=fields VAL, INP, MASK, NOBT, RVAL, SHFT, ZRVL, ONVL, TWVL, THVL, FRVL, FVVL, SXVL, SVVL, EIVL, NIVL, TEVL, ELVL, TVVL, TTVL, FTVL, FFVL
@@ -186,7 +118,7 @@ description (DESC) fields.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_ENUM) {
prompt("Current Value")
promptgroup("40 - Input")
@@ -478,7 +410,7 @@ state occurs, if set to MAJOR or MINOR.
The other fields, when set to MAJOR or MINOR, trigger an alarm when VAL equals
the corresponding state. See the See L<Alarm Specification> for a complete
explanation of discrete alarms and these fields. L<Alarm Fields> lists other
fields related to a alarms that are common to all record types.
fields related to a alarms that are common to all record types.
=fields UNSV, COSV, ZRSV, ONSV, TWSV, THSV, FRSV, FVSV, SXSV, SVSV, EISV, NISV, TESV, ELSV, TVSV, TTSV, FTSV, FFSV
@@ -709,14 +641,6 @@ See L<Fields Common to Many Record Types> for more information on these fields.
menu(menuAlarmSevr)
}
=pod
=begin html
<br><hr><br>
=end html
=head2 Record Support
=head3 Record Support Routines
@@ -869,7 +793,6 @@ Scan forward link if necessary, set PACT FALSE, and return.
=back
=head2 Device Support
=head3 Fields Of Interest To Device Support
@@ -882,12 +805,6 @@ primarily interested in the following fields:
=fields PACT, DPVT, UDF, NSEV, NSTA, NOBT, VAL, INP, RVAL, MASK, SHFT
=begin html
<br><hr><br>
=end html
=head3 Device Support Routines
Device support consists of the following routines:
@@ -979,7 +896,6 @@ This module is like the previous except that values are read into RVAL, VAL is
computed from RVAL, and read_mbbi returns a value of 0. Thus the record
processing routine will determine VAL in the normal way.
=cut
}

70
src/std/rec/mbboDirectRecord.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 B<Multi-Bit Binary Output Direct Record (mbboDirect)>
=title Multi-Bit Binary Output Direct Record (mbboDirect)
The mbboDirect record performs the opposite function to that of the mbbiDirect
record. It accumulates bits (in the fields B0 - BF) as unsigned characters, and
@@ -15,56 +15,6 @@ converts them to a word which is then written out to hardware. If a bit field is
non-zero, it is interpreted as a binary 1. On the other hand, if it is zero, it
is interpreted as a binary 0.
=head1 L<Contents>
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Convert and Write Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br><hr><br>
=end html
=recordtype mbboDirect
=cut
@@ -73,21 +23,7 @@ recordtype(mbboDirect) {
=head2 Parameter Fields
The mbboDirect record's fields fall into the following categories:
=over
=item * L<Scan Parameters>
=item * L<Convert and Write Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -153,7 +89,7 @@ description (DESC) fields.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_USHORT) {
prompt("Word")
promptgroup("50 - Output")

46
src/std/rec/permissiveRecord.dbd.pod
View File

@@ -7,52 +7,14 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 Permissive Record (permissive)
=title Permissive Record (permissive)
The permissive record is for communication between a server and a client. An
example would be a sequence program server and an operator interface client. By
using multiple permissive records a sequence program can communicate its current
state to the client.
B<Note this record is deprecated and is likely to be removed in a future EPICS release.>
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Client-server Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (permissiveRecord.c)>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
B<Note this record is deprecated and may be removed in a future EPICS release.>
=recordtype permissive
@@ -63,6 +25,8 @@ recordtype(permissive) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The permissive record has the standard fields for specifying under what
@@ -150,7 +114,7 @@ OLFG.
=head2 Record Support
=head3 Record Support Routines (permissiveRecord.c)
=head3 Record Support Routines
=head4 process

63
src/std/rec/selRecord.dbd.pod
View File

@@ -7,59 +7,13 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=pod
=head1 Select Record (sel)
=title Select Record (sel)
The select record computes a value based on input obtained from up to 12
locations. The selection algorithm can be one of the following: C<<< Specified
>>>, C<<< High Signal >>>, C<<< Low Signal >>>, C<<< Median Signal >>>. Each
input can be a constant, a database link, or a channel access link.
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Select Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Monitor Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (selRecord.c)>
=item * L<Record Processing>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=recordtype sel
=cut
@@ -74,6 +28,8 @@ recordtype(sel) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The select record has the standard fields for specifying under what
@@ -206,17 +162,9 @@ equal to A, no monitor is invoked for A.
=fields VAL, LALM, ALST, MLST, LA, LB, LC, LD, LE, LF, LG, LH, LI, LJ, LK, LL
=begin html
<br>
<hr>
<br>
=end html
=head2 Record Support
=head3 Record Support Routines (selRecord.c)
=head3 Record Support Routines
=head4 init_record
@@ -336,7 +284,7 @@ Scan forward link if necessary, set PACT FALSE, and return.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_DOUBLE) {
prompt("Result")
promptgroup("40 - Input")
@@ -644,4 +592,3 @@ Scan forward link if necessary, set PACT FALSE, and return.
interest(3)
}
}

60
src/std/rec/seqRecord.dbd.pod
View File

@@ -4,7 +4,7 @@
# Copyright (c) 2002 The Regents of the University of California, as
# Operator of Los Alamos National Laboratory.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
# in file LICENSE that is included with this distribution.
#*************************************************************************
=title Sequence Record (seq)
@@ -28,63 +28,9 @@ menu(seqSELM) {
recordtype(seq) {
=pod
=head1 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Desired Output Parameters>
=item * L<Output Parameters>
=item * L<Selection Algorithm Parameters>
=item * L<Delay Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=back
=item * L<Record Support>
=back
=begin html
<br><hr><br>
=end html
=head2 Parameter Fields
The fields fall into the following categories:
=over
=item * L<Scan Parameters>
=item * L<Desired Output Parameters>
=item * L<Output Parameters>
=item * L<Selection Algorithm Parameters>
=item * L<Delay Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=back
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -294,7 +240,7 @@ information on call
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_LONG) {
prompt("Used to trigger")
asl(ASL0)

42
src/std/rec/stateRecord.dbd.pod
View File

@@ -7,48 +7,14 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 State Record (state)
=title State Record (state)
The state record is a means for a state program to communicate with the operator
interface. Its only function is to provide a place in the database through which
the state program can inform the operator interface of its state by storing an
arbitrary ASCII string in its VAL field.
B<Note this record is deprecated and is likely to be removed in a future EPICS release.>
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (stateRecord.c)>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
B<Note this record is deprecated and may be removed in a future EPICS release.>
=recordtype state
@@ -59,6 +25,8 @@ recordtype(state) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The state record has the standard fields for specifying under what circumstances
@@ -106,7 +74,7 @@ They represent the current state of the sequence program.
=head2 Record Support
=head3 Record Support Routines (stateRecord.c)
=head3 Record Support Routines
=head4 process

68
src/std/rec/stringinRecord.dbd.pod
View File

@@ -7,67 +7,13 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 String Input Record (stringin)
=title String Input Record (stringin)
The string input record retrieves an arbitrary ASCII string of up to 40
characters. Several device support routines are available, all of which are soft
device support for retrieving values from other records or other software
components.
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Monitor Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (stringinRecord.c)>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines (devSiSoft.c)>
=item * L<Device Support for Soft Records>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=recordtype stringin
=cut
@@ -88,6 +34,8 @@ recordtype(stringin) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The string input record has the standard fields for specifying under what
@@ -206,17 +154,9 @@ mode. See L<Simulation Mode> for more information on simulation mode fields.
menu(menuAlarmSevr)
}
=begin html
<br>
<hr>
<br>
=end html
=head2 Record Support
=head3 Record Support Routines (stringinRecord.c)
=head3 Record Support Routines
=head4 init_record

62
src/std/rec/stringoutRecord.dbd.pod
View File

@@ -7,67 +7,11 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 String Output Record (stringout)
=title String Output Record (stringout)
The stringout record is used to write an arbitrary ASCII string of up to 40
characters to other records or software variables.
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Desired Output Parameters>
=item * L<Write Parameters>
=item * L<Monitor Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time and Simulation Mode Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (stringoutRecord.c)>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines (devSoSoft.c)>
=item * L<Device Support for Soft Records>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=recordtype stringout
=cut
@@ -90,6 +34,8 @@ recordtype(stringout) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The string output record has the standard fields for specifying under what
@@ -285,7 +231,7 @@ for more information on these fields.
=head2 Record Support
=head3 Record Support Routines (stringoutRecord.c)
=head3 Record Support Routines
=head4 init_record

70
src/std/rec/subArrayRecord.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 Sub-Array Record (subArray)
=title Sub-Array Record (subArray)
The normal use for the subArray record type is to obtain sub-arrays from
waveform records. Setting either the number of elements (NELM) or index (INDX)
@@ -23,64 +23,6 @@ elements actually available are returned, and the number of elements read field
(NORD) is set to reflect this. This record type does not support writing new
values into waveform records.
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Array Parameters>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (subArrayRecord.c)>
=item * L<Record Processing>
=item * L<Example Synchronous Subroutine>
=item * L<Example Asynchronous Subroutine>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines (devSASoft.c)>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=recordtype subArray
=cut
@@ -89,14 +31,14 @@ recordtype(subArray) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The subArray record has the standard fields for specifying under what
circumstances the record will be processed. These fields are listed in
L<Scan Fields>.
In addition,
L<Scanning Specification>
explains how these fields are used.
In addition, L<Scanning Specification> explains how these fields are used.
=head3 Read Parameters
@@ -186,7 +128,7 @@ BPTR contains a pointer to the record's array.
=head2 Record Support
=head3 Record Support Routines (subArrayRecord.c)
=head3 Record Support Routines
=head4 init_record
@@ -372,7 +314,7 @@ INP is expected to point to a waveform record.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_NOACCESS) {
prompt("Value")
asl(ASL0)

73
src/std/rec/subRecord.dbd.pod
View File

@@ -4,62 +4,14 @@
# Copyright (c) 2002 The Regents of the University of California, as
# Operator of Los Alamos National Laboratory.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head1 Subroutine Record (sub)
=title Subroutine Record (sub)
The subroutine record is used to call a C initialization routine and a recurring
scan routine. There is no device support for this record.
=head2 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Subroutine Connection>
=item * L<Operator Display Parameters>
=item * L<Alarm Parameters>
=item * L<Monitor Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines (subRecord.c)>
=item * L<Record Processing>
=item * L<Example Synchronous Subroutine>
=item * L<Example Asynchronous Subroutine>
=back
=back
=begin html
<br>
<hr>
<br>
=end html
=recordtype sub
=cut
@@ -68,6 +20,8 @@ recordtype(sub) {
=head2 Parameter Fields
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The subroutine record has the standard fields for specifying under what
@@ -170,7 +124,7 @@ monitors are called for that field.
=head2 Record Support
=head3 Record Support Routines (subRecord.c)
=head3 Record Support Routines
=head4 init_record
@@ -307,19 +261,19 @@ called.
#include <subRecord.h>
#include <registryFunction.h>
#include <epicsExport.h>
static long subInit(struct subRecord *psub)
{
printf("subInit was called\n");
return 0;
}
static long subProcess(struct subRecord *psub)
{
psub->val++;
return 0;
}
epicsRegisterFunction(subInit);
epicsRegisterFunction(subProcess);
@@ -396,14 +350,14 @@ processing.
#include <dbDefs.h>
#include <dbAccess.h>
#include <subRecord.h>
/* control block for callback*/
struct callback {
CALLBACK callback;
struct dbCommon *precord;
WDOG_ID wd_id;
};
void myCallback(struct callback *pcallback)
{
struct dbCommon *precord=pcallback->precord;
@@ -412,7 +366,7 @@ processing.
(*prset->process)(precord);
dbScanUnlock(precord);
}
long subInit(struct subRecord *psub)
{
struct callback *pcallback;
@@ -424,7 +378,7 @@ processing.
printf("subInit was called\n");
return 0;
}
long subProcess(struct subRecord *psub)
{
struct callback *pcallback=(struct callback *)(psub->dpvt);
@@ -454,7 +408,7 @@ processing.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_DOUBLE) {
prompt("Result")
asl(ASL0)
@@ -773,4 +727,3 @@ processing.
interest(3)
}
}

70
src/std/rec/waveformRecord.dbd.pod
View File

@@ -4,7 +4,7 @@
# Copyright (c) 2002 The Regents of the University of California, as
# Operator of Los Alamos National Laboratory.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
# in file LICENSE that is included with this distribution.
#*************************************************************************
=title Waveform Record (waveform)
@@ -26,71 +26,9 @@ menu(waveformPOST) {
recordtype(waveform) {
=pod
=head1 Contents
=over
=item * L<Parameter Fields>
=over
=item * L<Scan Parameters>
=item * L<Read Parameters>
=item * L<Operator Display Parameters>
=item * L<Run-time Parameters>
=back
=item * L<Record Support>
=over
=item * L<Record Support Routines>
=item * L<Record Processing>
=back
=item * L<Device Support>
=over
=item * L<Fields Of Interest To Device Support>
=item * L<Device Support Routines>
=item * L<Device Support For Soft Records>
=back
=back
=begin html
<hr>
=end html
=head2 Parameter Fields
The waveform's fields fall into the following categories:
=over
=item * L<Scan Parameters>;
=item * L<Read Parameters>;
=item * L<Operator Display Parameters>;
=item * L<Run-time Parameters>;
=back
The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
@@ -120,7 +58,7 @@ 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.
The RARM field causes the device to re-arm when this field is set to 1.
=head4 Possible data types for FTVL
@@ -458,7 +396,7 @@ NORD is set to the number of values returned and read_wf returns.
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
field(VAL,DBF_NOACCESS) {
prompt("Value")
asl(ASL0)