doc: update simulation parameters sections in dbds

- refer to appropriate sections in dbCommonInput/dbCommonOutput
This commit is contained in:
Ralph Lange
2020-05-20 19:47:14 +02:00
parent b0cd3518e4
commit 96f9f355c9
19 changed files with 286 additions and 145 deletions

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

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

View File

@@ -441,35 +441,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

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

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"
@@ -235,6 +228,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")

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

View File

@@ -238,29 +238,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
@@ -375,14 +366,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.

View File

@@ -279,28 +279,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

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

View File

@@ -298,7 +298,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
@@ -308,15 +308,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)

View File

@@ -133,7 +133,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
@@ -142,11 +142,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

View File

@@ -192,7 +192,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
@@ -201,10 +201,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

View File

@@ -127,7 +127,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.
@@ -139,11 +139,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

View File

@@ -609,14 +609,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)

View File

@@ -155,7 +155,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.
@@ -167,10 +167,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

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"
field(VAL,DBF_ENUM) {
prompt("Desired Value")
promptgroup("50 - Output")

View File

@@ -111,21 +111,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)

View File

@@ -146,23 +146,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)

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