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

Merge remote-tracking branch 'githubrl/doc-sim-mode' into 7.0

Browse Source 
* githubrl/doc-sim-mode:
  doc: update simulation parameters sections in dbds
  doc: add description of improved simulation mode

# Conflicts:
#	modules/database/src/std/rec/mbboRecord.dbd.pod
This commit is contained in:
Michael Davidsaver
2020-05-21 11:42:24 -07:00
parent 36a8b51d8e 96f9f355c9
commit 4c192e7bba
21 changed files with 387 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
modules/database/src/ioc/db/dbCommonInput.pod
View File

@@ -85,56 +85,72 @@ support read routine normally returns the status from C<dbGetLink()>.
=head3 Input Simulation Fields
The B<SIMM> field controls simulation mode. It has either the value YES or NO.
By setting this field to YES, the record can be switched into simulation mode
of operation. While in simulation mode, input will be obtained from SIOL
instead of INP.
The B<SIMM> field controls simulation mode.
By setting this field to YES or RAW, the record can be switched into
simulation mode of operation.
While in simulation mode, input will be obtained from SIOL instead of INP.
Ths B<SIML> specifies the simulation mode location. This field can be a
The B<SIML> field specifies the simulation mode location. This field can be a
constant, a database link, or a channel access link. If SIML is a database or
channel access link, then SIMM is read from SIML. If SIML is a constant link
then SIMM is initialized with the constant value but can be changed via
dbPuts.
then SIMM is initialized with the constant value, but can be changed via
database or channel access puts.
Ths B<SVAL> field contains the simulation value. This is the record's input
The B<SVAL> field contains the simulation value. This is the record's input
value, in engineering units, when the record is switched into simulation mode,
i.e. when SIMM is set to YES.
i.e., SIMM is set to YES or RAW. If the record type supports conversion,
setting SIMM to RAW causes SVAL to be written to RVAL and the conversion to
be done.
The B<SIOL> field is a link that can be used to fetch the simulation value. The
link can be a constant, a database link, or a channel access link. If SIOL is a
database or channel access link, then SVAL is read from SIOL. If SIOL is a
constant link then SVAL is initialized with the constant value but can be
changed via dbPuts.
changed via database or channel access puts.
The B<SIMS> field specifies the simulation mode alarm severity. When this
field is set to a value other than NO_ALARM and the record is in simulation
mode, it will be put into alarm with this severity and a status of SIMM.
mode, it will be put into alarm with this severity and a status of SIMM_ALARM.
The B<SDLY> field specifies a delay (in seconds) to implement asynchronous
processing in simulation mode. A positive SDLY value will be used as delay
between the first and second phase of processing in simulation mode.
A negative value (default) specifies synchronous processing.
The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Input Records
An input record can be switched into simulation mode of operation by setting
the value of SIMM to YES or RAW. During simulation, the record will be put
into alarm with a severity of SIMS and a status of SIMM_ALARM. While in
simulation mode, input values will be read from SIOL instead of INP:
-- (SIMM = NO?) INP (if supported and directed by device support, -> RVAL -- convert -> VAL), (else -> VAL)
/
the value of SIMM to YES or RAW.
During simulation, the record will be put into alarm with a severity of SIMS
and a status of SIMM_ALARM.
-- (SIMM = NO?)
/ (if supported and directed by device support,
/ INP -> RVAL -- convert -> VAL),
(else INP -> VAL)
SIML -> SIMM
\
-- (SIMM = YES?) SIOL -> SVAL -> VAL
-- (SIMM = YES?) SIOL -> SVAL -> VAL
\
-- (SIMM = RAW?) SIOL -> SVAL -> RVAL -- convert -> VAL
A record can be switched into simulation mode of operation by setting the
value of SIMM to YES. During simulation, the record will be put into alarm
with a severity of SIMS and a status of SIMM_ALARM. While in simulation mode,
input values, in engineering units, will be obtained from SIOL instead of INP.
Also, while the record is in simulation mode, there will be no raw value
conversion and no calls to device support when the record is processed.
If SIMM is set to YES, the input value, in engineering units, will be obtained
from SIOL instead of INP and directly written to the VAL field.
If SIMM is set to RAW, the value read through SIOL will be truncated and
written to the RVAL field, followed by the regular raw value conversion.
While the record is in simulation mode, there will be no calls to device
support when the record is processed.
Normally input records contain a private readValue() routine which performs
If SIOL contains a link, a TSE setting of "time from device" (-2) is honored
in simulation mode by taking the time stamp from the record that SIOL points
to.
Normally input records contain a private C<readValue()> routine which performs
the following steps:
=over
@@ -159,19 +175,30 @@ return code, and return.
=item *
If SIMM is YES, then call C<dbGetLink()> to read the input value from SIOL
into SVAL. If success, then set VAL to SVAL and UDF to FALSE and set status to
2 (don't convert) if input record supports conversion. If SIMS is greater than
zero, set alarm status to SIMM and severity to SIMS. Set status to the return
code from recGblGetLinkValue and return.
If SIMM is YES or RAW, then
=over
=item *
If SIMM is RAW, then call C<dbGetLink()> to read the input value from SIOL
into SVAL. If success, then set RVAL to SVAL and UDF to FALSE and set status
to 0 (convert) if input record supports conversion. If SIMS is greater than
zero, set alarm status to SIMM and severity to SIMS. Set status to the return
code from recGblGetLinkValue and return.
Set alarm status to SIMM_ALARM and severity to SIMS,
if SIMS is greater than zero.
=item *
If the record simulation processing is synchronous (SDLY < 0) or the record is
in the second phase of an asynchronous processing, call C<dbGetLink()>
to read the input value from SIOL into SVAL.
Set status to the return code from C<dbGetLink()>.
If the call succeeded and SIMM is YES, write the value to VAL and set the
status to 2 (don't convert),
if SIMM is RAW and the record type supports conversion, cast the value to RVAL
and leave the status as 0 (convert).
Otherwise (record is in first phase of an asynchronous processing), set up a
callback processing with the delay specified in SDLY.
=back
=item *

50
modules/database/src/ioc/db/dbCommonOutput.pod
View File

@@ -142,27 +142,36 @@ If IVOA not one of the above, an error message is generated.
=back
=head3 Simulation Fields
=head3 Output Simulation Fields
The B<SIMM> field controls simulation mode. It has either the value YES or NO.
By setting this field to YES, the record can be switched into simulation mode
of operation. While in simulation mode, output will be forwarded through SIOL
instead of OUT.
Ths B<SIML> specifies the simulation mode location. This field can be a
The B<SIML> field specifies the simulation mode location. This field can be a
constant, a database link, or a channel access link. If SIML is a database or
channel access link, then SIMM is read from SIML. If SIML is a constant link
then SIMM is initialized with the constant value but can be changed via
dbPuts.
then SIMM is initialized with the constant value, but can be changed via
database or channel access puts.
The B<SIOL> field is a link that the output value is written to when the record
is in simulation mode.
The B<SIMS> field specifies the simulation mode alarm severity. When this
field is set to a value other than NO_ALARM and the record is in simulation
mode, it will be put into alarm with this severity and a status of SIMM.
mode, it will be put into alarm with this severity and a status of SIMM_ALARM.
=head3 Simulation Mode
The B<SDLY> field specifies a delay (in seconds) to implement asynchronous
processing in simulation mode. A positive SDLY value will be used as delay
between the first and second phase of processing in simulation mode.
A negative value (default) specifies synchronous processing.
The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Output Records
An output record can be switched into simulation mode of operation by setting
the value of SIMM to YES. During simulation, the record will be put into alarm
@@ -198,14 +207,33 @@ return code, and return.
=item *
If SIMM is YES, then call C<dbPutLink()> to write the output value from VAL or
OVAL to SIOL. Set alarm status to SIMM and severity to SIMS, if SIMS is
greater than zero. Set status to the return code from C<dbPutLink()> and
return.
If SIMM is YES, then
=over
=item *
If SIMM not one of the above, a SOFT alarm with a severity of INVALID is
Set alarm status to SIMM_ALARM and severity to SIMS,
if SIMS is greater than zero.
=item *
If the record simulation processing is synchronous (SDLY < 0) or the record is
in the second phase of an asynchronous processing, call C<dbPutLink()>
to write the output value from VAL or OVAL to SIOL.
Otherwise (record is in first phase of an asynchronous processing), set up a
callback processing with the delay specified in SDLY.
=item *
Set status to the return code from C<dbPutLink()> and return.
=back
=item *
If SIMM is not YES or NO, a SOFT alarm with a severity of INVALID is
raised, and return status is set to -1.
=back

17
modules/database/src/std/rec/aaiRecord.dbd.pod
View File

@@ -127,11 +127,20 @@ into the array.
=fields VAL, BPTR, NORD
The following fields are used to operate the array analog input record in the
simulation mode. See L<Simulation Mode> for more information on the simulation
mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=begin html

17
modules/database/src/std/rec/aaoRecord.dbd.pod
View File

@@ -127,11 +127,20 @@ the output,
=fields VAL, BPTR, NORD
The following fields are used to operate the array analog output record in the
simulation mode. See L<Simulation Mode> for more information on the simulation
mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=begin html

37
modules/database/src/std/rec/aiRecord.dbd.pod
View File

@@ -451,35 +451,22 @@ monitoring functionality.
interest(3)
}
=head3 Simulation Mode
=head3 Simulation Mode Parameters
The record provides several fields to support simulation of absent hardware.
If the SIML field is set it is used to read a value into the SIMM field, which
controls whether simulation is used or not:
The following fields are used to operate the record in simulation mode.
=over
If SIMM (fetched through SIML) is YES or RAW, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
If SIMM is YES, SVAL is written to VAL without conversion,
if SIMM is RAW, SVAL is trancated to RVAL and converted.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
=item *
SIMM must be zero (C<NO>) for the record to request a value from the device
support.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=item *
If SIMM is C<YES> and the SIOL link field is set, a simlated value in
engineering units is read using the link into the SVAL field, from where it will
subsequently be copied into the VAL field.
=item *
If SIMM is C<RAW> the SIOL link is still read into SVAL, but is then truncated
and copied into the RVAL field.
The L</Units Conversion> process described above is then followed to transform
the simulated raw value into engineering units.
=back
The SIMS field can be set to give the record an alarm severity while it is in
simulation mode.
=fields SIML, SIMM, SIOL, SVAL, SIMS
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut

19
modules/database/src/std/rec/aoRecord.dbd.pod
View File

@@ -228,7 +228,7 @@ a complete explanation of monitors.
=fields ADEL, MDEL
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
These parameters are used by the run-time code for processing the
analog output. They are not configurable. They represent the current
@@ -259,11 +259,20 @@ processing.
=fields ORAW, RBV, ORBV, LALM, ALST, MLST, INIT, PBRK, LBRK, PVAL, OMOD
The following fields are used when the record is in simulation mode. See
L<Fields Common to Output Record Types|dbCommonOutput/Simulation Fields> for
more information on these fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL, without conversion.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

29
modules/database/src/std/rec/biRecord.dbd.pod
View File

@@ -131,7 +131,7 @@ common to all record types.
=fields ZSV, OSV, COSV
=head3 Run-time Parameters and Simulation Mode Parameters
=head3 Run-time Parameters
These parameters are used by the run-time code for processing the binary
input. They are not configured using a database configuration tool.
@@ -153,13 +153,6 @@ is not equal to VAL.
=fields ORAW, MASK, LALM, MLST
The following fields are used to operate the binary input in simulation
mode. See L<Fields Common to Many Record Types> for more information on
these fields.
=fields SIOL, SVAL, SIML, SIMM, SIMS
=cut
include "dbCommon.dbd"
@@ -244,6 +237,26 @@ these fields.
special(SPC_NOMOD)
interest(3)
}
=head3 Simulation Mode Parameters
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES or RAW, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
If SIMM is YES, SVAL is written to VAL without conversion,
if SIMM is RAW, SVAL is trancated to RVAL and converted.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut
field(SIOL,DBF_INLINK) {
prompt("Simulation Input Link")
promptgroup("90 - Simulate")

19
modules/database/src/std/rec/boRecord.dbd.pod
View File

@@ -170,7 +170,7 @@ common to all record types.
=fields ZSV, OSV, COSV, IVOA, IVOV
=head3 Run-Time and Simulation Mode Parameters
=head3 Run-Time Parameters
These parameters are used by the run-time code for processiong the binary
output. They are not configurable using a configuration tool. They
@@ -201,11 +201,20 @@ The WPDT field is a private field for honoring seconds to hold HIGH.
=fields ORAW, MASK, RBV, ORBV, LALM, MLST, RPVT, WDPT
The following fields are used to operate the binary output in the
simulation mode. See L<Fields Common to Many Record Types> for more
information on these fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

55
modules/database/src/std/rec/int64inRecord.dbd.pod
View File

@@ -247,29 +247,20 @@ monitoring deadband functionality.
interest(3)
}
=head3 Simulation Mode
=head3 Simulation Mode Parameters
The record provides several fields to support simulation of absent hardware.
If the SIML field is set it is used to read a value into the SIMM field, which
controls whether simulation is used or not:
The following fields are used to operate the record in simulation mode.
=over
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
=item *
SIMM must be zero (C<NO>) for the record to request a value from the device
support.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=item *
If SIMM is C<YES> and the SIOL link field is set, a simulated value in
engineering units is read using the link into the SVAL field, from where it will
subsequently be copied into the VAL field.
=back
The SIMS field can be set to give the record an alarm severity while it is in
simulation mode.
=fields SIML, SIMM, SIOL, SVAL, SIMS
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut
@@ -384,14 +375,30 @@ If PACT is FALSE, read the value, honoring simulation mode:
=item * If SIMM is C<NO>,
call the device support C<read_int64in> routine and return.
=item * If SIMM is C<YES>,
read the simulated value into SVAL using the SIOL link,
then copy the value into VAL and set UDF to 0 on success.
=item * If SIMM is C<YES>, then
=over
=item *
Set alarm status to SIMM_ALARM and severity to SIMS,
if SIMS is greater than zero.
=item *
If the record simulation processing is synchronous (SDLY < 0) or the record is
in the second phase of an asynchronous processing, call C<dbGetLink()>
to read the input value from SIOL into SVAL.
Set status to the return code from C<dbGetLink()>.
If the call succeeded, write the value to VAL and set UDF to 0.
Otherwise (record is in first phase of an asynchronous processing), set up a
callback processing with the delay specified in SDLY.
=back
=item * Raise an alarm for other values of SIMM.
=item * Set the record to the severity configured in SIMS.
=back
=item 3.

28
modules/database/src/std/rec/int64outRecord.dbd.pod
View File

@@ -288,28 +288,20 @@ monitoring deadband functionality.
interest(3)
}
=head3 Simulation Mode
=head3 Simulation Mode Parameters
The record provides several fields to support simulation of absent hardware.
If the SIML field is set it is used to read a value into the SIMM field,
which controls whether simulation is used or not:
The following fields are used to operate the record in simulation mode.
=over
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
=item *
SIMM must be zero (C<NO>) for the record to write a value to the device
support.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=item *
If SIMM is C<YES> and the SIOL link field is set, the value in engineering
units is written using the link.
=back
The SIMS field can be set to give the record an alarm severity while it is in
simulation mode.
=fields SIML, SIMM, SIOL, SIMS
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

18
modules/database/src/std/rec/longinRecord.dbd.pod
View File

@@ -95,7 +95,7 @@ monitors. See L<Monitor Specification> for a complete explanation of monitors.
=fields ADEL, MDEL
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The LALM, MLST, and ALST fields are used to implement the hysteresis factors for
monitor callbacks. Only if the difference between these fields and the
@@ -105,10 +105,20 @@ between VAL and MLST is greater than MDEL are the monitors triggered for VAL.
=fields LALM, ALST, MLST
The following fields are used to operate the long input in the simulation mode.
See L<Fields Common to Many Record Types> for more information on these fields.
=head3 Simulation Mode Parameters
=fields SIOL, SVAL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=head2 Record Support

21
modules/database/src/std/rec/longoutRecord.dbd.pod
View File

@@ -307,7 +307,7 @@ monitors.
interest(3)
}
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The LALM, MLST, and ALST fields are used to implement the hysteresis factors for
monitor callbacks. Only if the difference between these fields and the
@@ -317,15 +317,24 @@ between VAL and MLST is greater than MDEL are the monitors triggered for VAL.
=fields LALM, ALST, MLST
The following fields are used to operate the long output in the simulation mode.
See L<Fields Common to Many Record Types> for more information on the simulation
mode fields
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut
field(SIOL,DBF_OUTLINK) {
field(SIOL,DBF_OUTLINK) {
prompt("Sim Output Specifctn")
promptgroup("90 - Simulate")
interest(1)

17
modules/database/src/std/rec/lsiRecord.dbd.pod
View File

@@ -130,7 +130,7 @@ The long string input record has the alarm parameters common to all record
types. L<Alarm Fields> lists other fields related to a alarms that are common to
all record types.
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The old value field (OVAL) of the long string input record is used to implement
value change monitors for VAL. If VAL is not equal to OVAL, then monitors are
@@ -139,11 +139,20 @@ length of the string in OVAL.
=fields OVAL, LEN, OLEN
=head3 Simulation Mode Parameters
The following fields are used to operate the string input in the simulation
mode. See L<Simulation Mode> for more information on simulation mode fields.
The following fields are used to operate the record in simulation mode.
=fields SIOL, SIML, SIMM, SIMS
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

18
modules/database/src/std/rec/lsoRecord.dbd.pod
View File

@@ -189,7 +189,7 @@ lists other fields related to a alarms that are common to all record types.
}
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The old value field (OVAL) of the long string input record is used to implement
value change monitors for VAL. If VAL is not equal to OVAL, then monitors are
@@ -198,10 +198,20 @@ length of the string in OVAL.
=fields OVAL, LEN, OLEN
The following fields are used to operate the string input in the simulation
mode. See L<Simulation Mode> for more information on simulation mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

21
modules/database/src/std/rec/mbbiDirectRecord.dbd.pod
View File

@@ -135,7 +135,7 @@ description (DESC) fields.
interest(1)
}
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
These parameters are used by the run-time code for processing the mbbi direct
record. They are not configurable prior to run-time.
@@ -147,11 +147,22 @@ MLST holds the value when the last monitor for value change was triggered.
=fields NOBT, ORAW, MASK, MLST
The following fields are used to operate the mbbiDirect record in the simulation
mode. See L<Fields Common to Many Record Types> for more information on these
fields.
=head3 Simulation Mode Parameters
=fields SIOL, SVAL, SIML, SIMM, SIMS, SSCN, SDLY
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES or RAW, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
If SIMM is YES, SVAL is written to VAL without conversion,
if SIMM is RAW, SVAL is trancated to RVAL and converted.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut

18
modules/database/src/std/rec/mbbiRecord.dbd.pod
View File

@@ -617,14 +617,24 @@ SDEF is used by record support to save time if no states are defined.
=head3 Simulation Mode Parameters
The following fields are used to operate the mbbi record in the simulation mode.
See L<Fields Common to Many Record Types> for more information on these fields.
The following fields are used to operate the record in simulation mode.
=fields SIOL, SVAL, SIML, SIMM, SIMS, SSCN, SDLY
If SIMM (fetched through SIML) is YES or RAW, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
If SIMM is YES, SVAL is written to VAL without conversion,
if SIMM is RAW, SVAL is trancated to RVAL and converted.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut
field(SIOL,DBF_INLINK) {
field(SIOL,DBF_INLINK) {
prompt("Simulation Input Link")
promptgroup("90 - Simulate")
interest(1)

18
modules/database/src/std/rec/mbboDirectRecord.dbd.pod
View File

@@ -163,7 +163,7 @@ description (DESC) fields.
interest(1)
}
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
These parameters are used by the run-time code for processing the mbbo Direct
record.
@@ -175,10 +175,20 @@ MLST holds the value when the last monitor for value change was triggered.
=fields NOBT, ORAW, MASK, MLST
The following fields are used to operate the mbboDirect record in the simulation
mode. See L<Simulation Mode> for more information on the simulation mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS, SSCN, SDLY
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL, without conversion.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut

21
modules/database/src/std/rec/mbboRecord.dbd.pod
View File

@@ -145,7 +145,7 @@ common to all record types.
=fields UNSV, COSV, IVOA, IVOV, ZRSV, ONSV, TWSV, THSV, FRSV, FVSV, SXSV, SVSV, EISV, NISV, TESV, ELSV, TVSV, TTSV, FTSV, FFSV
=head3 Run-Time and Simulation Mode Parameters
=head3 Run-Time Parameters
These parameters are used by the run-time code for processing the multi-bit
binary output.
@@ -164,15 +164,24 @@ for converting VAL to RVAL.
=fields NOBT, ORAW, MASK, LALM, MLST, SDEF
The following fields are used to operate the mbbo record in the simulation mode.
See L<Fields Common to Many Record Types> for more information on the simulation
mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS, SSCN, SDLY
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL, without conversion.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut
include "dbCommon.dbd"
include "dbCommon.dbd"
%/* Declare Device Support Entry Table */
%struct mbboRecord;
%typedef struct mbbodset {

20
modules/database/src/std/rec/stringinRecord.dbd.pod
View File

@@ -120,21 +120,31 @@ The string input record has the alarm parameters common to all record types.
L<Alarm Fields> lists other fields related to a alarms that are common to all
record types.
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The old value field (OVAL) of the string input is used to implement value change
monitors for VAL. If VAL is not equal to OVAL, then monitors are triggered.
=fields OVAL
The following fields are used to operate the string input in the simulation
mode. See L<Simulation Mode> for more information on simulation mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SVAL, SIML, SIMM, SIMS, SSCN, SDLY
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL (buffered in SVAL).
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SVAL, SIMS, SDLY, SSCN
=cut
field(SIOL,DBF_INLINK) {
field(SIOL,DBF_INLINK) {
prompt("Simulation Input Link")
promptgroup("90 - Simulate")
interest(1)

22
modules/database/src/std/rec/stringoutRecord.dbd.pod
View File

@@ -155,23 +155,31 @@ for more on the record name (NAME) and description (DESC) fields.
=fields NAME, DESC
=head3 Run-time and Simulation Mode Parameters
=head3 Run-time Parameters
The old value field (OVAL) of the string input is used to implement value change
monitors for VAL. If VAL is not equal to OVAL, then monitors are triggered.
=fields OVAL
The following fields are used to operate the string output in the simulation
mode. See
L<Simulation Mode>
for more information on these fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS, SSCN, SDLY
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is written through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Output Simulation Fields|dbCommonOutput/Output Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=cut
field(SIOL,DBF_OUTLINK) {
field(SIOL,DBF_OUTLINK) {
prompt("Simulation Output Link")
promptgroup("90 - Simulate")
interest(1)

16
modules/database/src/std/rec/waveformRecord.dbd.pod
View File

@@ -131,10 +131,20 @@ indicates if the device is armed but has not yet been digitized.
=fields VAL, BPTR, NORD, BUSY
The following fields are used to operate the waveform in the simulation mode.
See L<Simulation Mode> for more information on the simulation mode fields.
=head3 Simulation Mode Parameters
=fields SIOL, SIML, SIMM, SIMS
The following fields are used to operate the record in simulation mode.
If SIMM (fetched through SIML) is YES, the record is put in SIMS
severity and the value is fetched through SIOL.
SSCN sets a different SCAN mechanism to use in simulation mode.
SDLY sets a delay (in sec) that is used for asynchronous simulation
processing.
See L<Input Simulation Fields|dbCommonInput/Input Simulation Fields>
for more information on simulation mode and its fields.
=fields SIML, SIMM, SIOL, SIMS, SDLY, SSCN
=begin html