ssh_monitor_core.template#
Note
Click here to check the source code of this file.
This file is a template file specifying the records that will be implemented by substitutions files.
In particular, the aSub record is the main one in this file: this record will hold and process the specified shells instructions through SSH commands, and it will return/output their results to the other records of this file.
See the glossary of this project for more details about EPICS records, templates, substitutions, etc.
Note that in the Doxygen documentation, a record is interpreted as a class, and an EPICS field is interpreted as a class attribute.
-
namespace ssh_monitor_core#
-
class record0#
aSub record called ‘${PREFIX}${CATEGORY}ASubCore’, and used to execute the specified shell instructions through the SSH command.
This aSub record has 21 inputs (‘INPA’, ‘INPB’, ‘INPC’, …, ‘INPU’):
The 1st input (‘INPA’) will specify the SSH options and arguments associated to the SSH command.
The 2nd input to the 16th input (‘INPB’ to ‘INPP’) will specify shell instructions that will return a scalar value.
The 17nd input to the 21th input (‘INPQ’ to ‘INPU’) will specify shell instructions that will return a string value.
This aSub record has also 21 outputs (‘OUTA’, ‘OUTB’, ‘OUTC’, …, ‘OUTU’):
The 1st output (‘OUTA’) will write the cache status of this aSub record into the ‘${PREFIX}${CATEGORY}${CACHE_STATUS_NAME=CacheStatus}’ bi record.
The 2nd output to the 16th output (‘OUTB’ to ‘OUTP’) will write the scalar values (retrieved from the shell instructions specified in ‘INPB’ to ‘INPP’) into the ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1=}’ to ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_15=}’ ai records.
The 17th output to the 21th output (‘OUTQ’ to ‘OUTU’) will write the string values (retrieved from the shell instructions specified in ‘INPQ’ to ‘INPU’) into the ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_1=}’ to ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_5=}’ ai records.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
’${SSH_OPTS_AND_ARGS}’
Note that other macros can (as in optional) be specified:
’${SCAN=60 second}’
’${SSH_OPTS_AND_ARGS_LENGTH=1024}’
’${SCALAR_1_INSTRUCTION=}’
’${SCALAR_1_INSTRUCTION_LENGTH=1024}’
’${SCALAR_2_INSTRUCTION=}’
’${SCALAR_2_INSTRUCTION_LENGTH=1024}’
’${SCALAR_3_INSTRUCTION=}’
’${SCALAR_3_INSTRUCTION_LENGTH=1024}’
’${SCALAR_4_INSTRUCTION=}’
’${SCALAR_4_INSTRUCTION_LENGTH=1024}’
’${SCALAR_5_INSTRUCTION=}’
’${SCALAR_5_INSTRUCTION_LENGTH=1024}’
’${SCALAR_6_INSTRUCTION=}’
’${SCALAR_6_INSTRUCTION_LENGTH=1024}’
’${SCALAR_7_INSTRUCTION=}’
’${SCALAR_7_INSTRUCTION_LENGTH=1024}’
’${SCALAR_8_INSTRUCTION=}’
’${SCALAR_8_INSTRUCTION_LENGTH=1024}’
’${SCALAR_9_INSTRUCTION=}’
’${SCALAR_9_INSTRUCTION_LENGTH=1024}’
’${SCALAR_10_INSTRUCTION=}’
’${SCALAR_10_INSTRUCTION_LENGTH=1024}’
’${SCALAR_11_INSTRUCTION=}’
’${SCALAR_11_INSTRUCTION_LENGTH=1024}’
’${SCALAR_12_INSTRUCTION=}’
’${SCALAR_12_INSTRUCTION_LENGTH=1024}’
’${SCALAR_13_INSTRUCTION=}’
’${SCALAR_13_INSTRUCTION_LENGTH=1024}’
’${SCALAR_14_INSTRUCTION=}’
’${SCALAR_14_INSTRUCTION_LENGTH=1024}’
’${SCALAR_15_INSTRUCTION=}’
’${SCALAR_15_INSTRUCTION_LENGTH=1024}’
’${STRING_1_INSTRUCTION=}’
’${STRING_1_INSTRUCTION_LENGTH=1024}’
’${STRING_2_INSTRUCTION=}’
’${STRING_2_INSTRUCTION_LENGTH=1024}’
’${STRING_3_INSTRUCTION=}’
’${STRING_3_INSTRUCTION_LENGTH=1024}’
’${STRING_4_INSTRUCTION=}’
’${STRING_4_INSTRUCTION_LENGTH=1024}’
’${STRING_5_INSTRUCTION=}’
’${STRING_5_INSTRUCTION_LENGTH=1024}’
’${CACHE_STATUS_NAME=CacheStatus}’
’${PV_NAME_SCALAR_1=}’
’${PV_NAME_SCALAR_2=}’
’${PV_NAME_SCALAR_3=}’
’${PV_NAME_SCALAR_4=}’
’${PV_NAME_SCALAR_5=}’
’${PV_NAME_SCALAR_6=}’
’${PV_NAME_SCALAR_7=}’
’${PV_NAME_SCALAR_8=}’
’${PV_NAME_SCALAR_9=}’
’${PV_NAME_SCALAR_10=}’
’${PV_NAME_SCALAR_11=}’
’${PV_NAME_SCALAR_12=}’
’${PV_NAME_SCALAR_13=}’
’${PV_NAME_SCALAR_14=}’
’${PV_NAME_SCALAR_15=}’
’${PV_NAME_STRING_1=}’
’${PV_NAME_STRING_2=}’
’${PV_NAME_STRING_3=}’
’${PV_NAME_STRING_4=}’
’${PV_NAME_STRING_5=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "aSub"#
Specifies the type of the record, which is ‘aSub’ (Array Subroutine Record). See https://web.archive.org/web/20211021101059/https://epics.anl.gov/base/R7-0/4-docs/aSubRecord.html for more details about the aSub record type.
-
static str NAME = "${PREFIX}${CATEGORY}ASubCore"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}ASubCore’. The name of this record will depend on the ‘${PREFIX}’ macro and the ‘${CATEGORY}’ macro, but will always end with ‘ASubCore’.
-
static str PINI = "1"#
Specifies record processing at initialization. If set to ‘1’ or ‘YES’, then the record is processed once at IOC initialization (before the normal scan tasks are started).
-
static str SCAN = "${SCAN=60 second}"#
Defines how often this aSub record should be processed. This field is set to the ‘SCAN’ macro, which defaults to ‘60 second’ and can be re-defined in the ‘.cmd’ file.
-
static str SNAM = "sshMonitorCoreProcess"#
Holds the name of the subroutine to be called when the aSub record processes. In this case, the ‘sshMonitorCoreProcess()’ function, located in ‘../src/sshmonitorASubCore.c’, will be called and run.
-
static str INPA = "${SSH_OPTS_AND_ARGS=}"#
Specifies the input A, holding the SSH options and arguments used to run the SSH command.
-
static str NOA = "${SSH_OPTS_AND_ARGS_LENGTH=1024}"#
Specifies the maximum number of element in INPA (1024 by default).
-
static str FTA = "CHAR"#
Specifies the type of INPA (here: not a simple char, but an array of chars thanks to the ‘NOA’ field above).
-
static str INPB = "${SCALAR_1_INSTRUCTION=}"#
Specifies the input B, holding a shell instruction to be executed.
-
static str NOB = "${SCALAR_1_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPB (1024 by default).
-
static str FTB = "CHAR"#
Specifies the type of INPB (here: not a simple char, but an array of chars thanks to the ‘NOB’ field above).
-
static str INPC = "${SCALAR_2_INSTRUCTION=}"#
Specifies the input C, holding a shell instruction to be executed.
-
static str NOC = "${SCALAR_2_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPC (1024 by default).
-
static str FTC = "CHAR"#
Specifies the type of INPC (here: not a simple char, but an array of chars thanks to the ‘NOC’ field above).
-
static str INPD = "${SCALAR_3_INSTRUCTION=}"#
Specifies the input D, holding a shell instruction to be executed.
-
static str NOD = "${SCALAR_3_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPD (1024 by default).
-
static str FTD = "CHAR"#
Specifies the type of INPD (here: not a simple char, but an array of chars thanks to the ‘NOD’ field above).
-
static str INPE = "${SCALAR_4_INSTRUCTION=}"#
Specifies the input E, holding a shell instruction to be executed.
-
static str NOE = "${SCALAR_4_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPE (1024 by default).
-
static str FTE = "CHAR"#
Specifies the type of INPE (here: not a simple char, but an array of chars thanks to the ‘NOE’ field above).
-
static str INPF = "${SCALAR_5_INSTRUCTION=}"#
Specifies the input F, holding a shell instruction to be executed.
-
static str NOF = "${SCALAR_5_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPF (1024 by default).
-
static str FTF = "CHAR"#
Specifies the type of INPF (here: not a simple char, but an array of chars thanks to the ‘NOF’ field above).
-
static str INPG = "${SCALAR_6_INSTRUCTION=}"#
Specifies the input G, holding a shell instruction to be executed.
-
static str NOG = "${SCALAR_6_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPG (1024 by default).
-
static str FTG = "CHAR"#
Specifies the type of INPG (here: not a simple char, but an array of chars thanks to the ‘NOG’ field above).
-
static str INPH = "${SCALAR_7_INSTRUCTION=}"#
Specifies the input H, holding a shell instruction to be executed.
-
static str NOH = "${SCALAR_7_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPH (1024 by default).
-
static str FTH = "CHAR"#
Specifies the type of INPH (here: not a simple char, but an array of chars thanks to the ‘NOH’ field above).
-
static str INPI = "${SCALAR_8_INSTRUCTION=}"#
Specifies the input I, holding a shell instruction to be executed.
-
static str NOI = "${SCALAR_8_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPI (1024 by default).
-
static str FTI = "CHAR"#
Specifies the type of INPI (here: not a simple char, but an array of chars thanks to the ‘NOI’ field above).
-
static str INPJ = "${SCALAR_9_INSTRUCTION=}"#
Specifies the input J, holding a shell instruction to be executed.
-
static str NOJ = "${SCALAR_9_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPJ (1024 by default).
-
static str FTJ = "CHAR"#
Specifies the type of INPJ (here: not a simple char, but an array of chars thanks to the ‘NOJ’ field above).
-
static str INPK = "${SCALAR_10_INSTRUCTION=}"#
Specifies the input K, holding a shell instruction to be executed.
-
static str NOK = "${SCALAR_10_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPK (1024 by default).
-
static str FTK = "CHAR"#
Specifies the type of INPK (here: not a simple char, but an array of chars thanks to the ‘NOK’ field above).
-
static str INPL = "${SCALAR_11_INSTRUCTION=}"#
Specifies the input L, holding a shell instruction to be executed.
-
static str NOL = "${SCALAR_11_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPL (1024 by default).
-
static str FTL = "CHAR"#
Specifies the type of INPL (here: not a simple char, but an array of chars thanks to the ‘NOL’ field above).
-
static str INPM = "${SCALAR_12_INSTRUCTION=}"#
Specifies the input M, holding a shell instruction to be executed.
-
static str NOM = "${SCALAR_12_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPM (1024 by default).
-
static str FTM = "CHAR"#
Specifies the type of INPM (here: not a simple char, but an array of chars thanks to the ‘NOM’ field above).
-
static str INPN = "${SCALAR_13_INSTRUCTION=}"#
Specifies the input N, holding a shell instruction to be executed.
-
static str NON = "${SCALAR_13_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPN (1024 by default).
-
static str FTN = "CHAR"#
Specifies the type of INPN (here: not a simple char, but an array of chars thanks to the ‘NON’ field above).
-
static str INPO = "${SCALAR_14_INSTRUCTION=}"#
Specifies the input O, holding a shell instruction to be executed.
-
static str NOO = "${SCALAR_14_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPO (1024 by default).
-
static str FTO = "CHAR"#
Specifies the type of INPO (here: not a simple char, but an array of chars thanks to the ‘NOO’ field above).
-
static str INPP = "${SCALAR_15_INSTRUCTION=}"#
Specifies the input P, holding a shell instruction to be executed.
-
static str NOP = "${SCALAR_15_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPP (1024 by default).
-
static str FTP = "CHAR"#
Specifies the type of INPP (here: not a simple char, but an array of chars thanks to the ‘NOP’ field above).
-
static str INPQ = "${STRING_1_INSTRUCTION=}"#
Specifies the input Q, holding a shell instruction to be executed.
-
static str NOQ = "${STRING_1_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPQ (1024 by default).
-
static str FTQ = "CHAR"#
Specifies the type of INPQ (here: not a simple char, but an array of chars thanks to the ‘NOQ’ field above).
-
static str INPR = "${STRING_2_INSTRUCTION=}"#
Specifies the input R, holding a shell instruction to be executed.
-
static str NOR = "${STRING_2_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPR (1024 by default).
-
static str FTR = "CHAR"#
Specifies the type of INPR (here: not a simple char, but an array of chars thanks to the ‘NOR’ field above).
-
static str INPS = "${STRING_3_INSTRUCTION=}"#
Specifies the input S, holding a shell instruction to be executed.
-
static str NOS = "${STRING_3_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPS (1024 by default).
-
static str FTS = "CHAR"#
Specifies the type of INPS (here: not a simple char, but an array of chars thanks to the ‘NOS’ field above).
-
static str INPT = "${STRING_4_INSTRUCTION=}"#
Specifies the input T, holding a shell instruction to be executed.
-
static str NOT = "${STRING_4_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPT (1024 by default).
-
static str FTT = "CHAR"#
Specifies the type of INPT (here: not a simple char, but an array of chars thanks to the ‘NOT’ field above).
-
static str INPU = "${STRING_5_INSTRUCTION=}"#
Specifies the input U, holding a shell instruction to be executed.
-
static str NOU = "${STRING_5_INSTRUCTION_LENGTH=1024}"#
Specifies the maximum number of element in INPU (1024 by default).
-
static str FTU = "CHAR"#
Specifies the type of INPU (here: not a simple char, but an array of chars thanks to the ‘NOU’ field above).
-
static str OUTA = "${PREFIX}${CATEGORY}${CACHE_STATUS_NAME=CacheStatus} PP"#
Specifies the output A, i.e. the name of the record where the cache status output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTB = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1=} PP"#
Specifies the output B, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTC = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_2=} PP"#
Specifies the output C, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTD = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_3=} PP"#
Specifies the output D, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTE = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_4=} PP"#
Specifies the output E, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTF = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_5=} PP"#
Specifies the output F, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTG = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_6=} PP"#
Specifies the output G, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTH = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_7=} PP"#
Specifies the output H, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTI = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_8=} PP"#
Specifies the output I, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTJ = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_9=} PP"#
Specifies the output J, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTK = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_10=} PP"#
Specifies the output K, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTL = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_11=} PP"#
Specifies the output L, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTM = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_12=} PP"#
Specifies the output M, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTN = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_13=} PP"#
Specifies the output N, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTO = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_14=} PP"#
Specifies the output O, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTP = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_15=} PP"#
Specifies the output P, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str OUTQ = "${PREFIX}${CATEGORY}${PV_NAME_STRING_1=} PP"#
Specifies the output Q, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str NOVQ = "${STRING_1_RESULT_MAX_LENGTH=1024}"#
Specifies the maxium possible number of element in OUTQ.
-
static str FTVQ = "CHAR"#
Specifies the type of OUTQ (here: not a simple char, but an array of chars thanks to the ‘NOVQ’ field above).
-
static str OUTR = "${PREFIX}${CATEGORY}${PV_NAME_STRING_2=} PP"#
Specifies the output R, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str NOVR = "${STRING_2_RESULT_MAX_LENGTH=1024}"#
Specifies the maxium possible number of element in OUTR.
-
static str FTVR = "CHAR"#
Specifies the type of OUTR (here: not a simple char, but an array of chars thanks to the ‘NOVR’ field above).
-
static str OUTS = "${PREFIX}${CATEGORY}${PV_NAME_STRING_3=} PP"#
Specifies the output S, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str NOVS = "${STRING_3_RESULT_MAX_LENGTH=1024}"#
Specifies the maxium possible number of element in OUTS.
-
static str FTVS = "CHAR"#
Specifies the type of OUTS (here: not a simple char, but an array of chars thanks to the ‘NOVS’ field above).
-
static str OUTT = "${PREFIX}${CATEGORY}${PV_NAME_STRING_4=} PP"#
Specifies the output T, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str NOVT = "${STRING_4_RESULT_MAX_LENGTH=1024}"#
Specifies the maxium possible number of element in OUTT.
-
static str FTVT = "CHAR"#
Specifies the type of OUTS (here: not a simple char, but an array of chars thanks to the ‘NOVT’ field above).
-
static str OUTU = "${PREFIX}${CATEGORY}${PV_NAME_STRING_5=} PP"#
Specifies the output U, i.e. the name of the record where the output will be send. Also note that ‘PP’ indicate to process that record.
-
static str NOVU = "${STRING_5_RESULT_MAX_LENGTH=1024}"#
Specifies the maxium possible number of element in OUTU.
-
static str FTVU = "CHAR"#
Specifies the type of OUTU (here: not a simple char, but an array of chars thanks to the ‘NOVU’ field above).
-
class record1#
bi record called ‘${PREFIX}${CATEGORY}${CACHE_STATUS_NAME=CacheStatus}’, and used to hold the status of the cache.
The status of the cache is ‘calculated’ by the subroutine of the previous ‘${PREFIX}${CATEGORY}ASubCore’ aSub record, which outputs its result through OUTA into this record.
If the value of the associated PV is 0, then the cache status is OK.
If the value of the associated PV is 1, then the cache status is not OK.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified:
’${CACHE_STATUS_NAME=CacheStatus}’
’${OSV_CACHE_STATUS=MAJOR}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "bi"#
Specifies the type of the record, which is ‘bi’ (binary input). See https://web.archive.org/web/20210326162104/https://epics.anl.gov/base/R7-0/4-docs/biRecord.html for more details about the bi record type.
-
static str NAME = "${PREFIX}${CATEGORY}${CACHE_STATUS_NAME=CacheStatus}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${CACHE_STATUS_NAME=CacheStatus}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${CACHE_STATUS_NAME=CacheStatus}’ macro (which defaults to ‘CacheStatus’).
-
static str OSV = "${OSV_CACHE_STATUS=MAJOR}"#
Specifies the severity of the associated PV. Severity becomes ‘MAJOR’ if the associated PV value reach 1.
-
class record2#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_1=#}’
’${PV_NAME_SCALAR_1=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_1=16}’
’${DESC_SCALAR_1=}’
’${LOAD_DESC_SCALAR_1=}’
’${EGU_SCALAR_1=}’
’${LOAD_EGU_SCALAR_1=}’
’${HYST_SCALAR_1=}’
’${LOAD_HYST_SCALAR_1=}’
’${DRVL_SCALAR_1=}’
’${LOAD_DRVL_SCALAR_1=}’
’${DRVH_SCALAR_1=}’
’${LOAD_DRVH_SCALAR_1=}’
’${HOPR_SCALAR_1=}’
’${LOAD_HOPR_SCALAR_1=}’
’${LOPR_SCALAR_1=}’
’${LOAD_LOPR_SCALAR_1=}’
’${HIGH_SCALAR_1=}’
’${LOAD_HIGH_SCALAR_1=}’
’${HSV_SCALAR_1=}’
’${LOAD_HSV_SCALAR_1=}’
’${HIHI_SCALAR_1=}’
’${LOAD_HIHI_SCALAR_1=}’
’${HHSV_SCALAR_1=}’
’${LOAD_HHSV_SCALAR_1=}’
’${LOW_SCALAR_1=}’
’${LOAD_LOW_SCALAR_1=}’
’${LSV_SCALAR_1=}’
’${LOAD_LSV_SCALAR_1=}’
’${LOLO_SCALAR_1=}’
’${LOAD_LOLO_SCALAR_1=}’
’${LLSV_SCALAR_1=}’
’${LOAD_LLSV_SCALAR_1=}’
’${ADEL_SCALAR_1=}’
’${LOAD_ADEL_SCALAR_1=}’
’${MDEL_SCALAR_1=}’
’${LOAD_MDEL_SCALAR_1=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_1=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_1=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_1=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_1=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_1=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_1=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_1=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_1=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_1=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_1=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_1=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_1=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_1=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_1=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_1=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_1=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_1=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_1=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_1=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_1=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record3#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_2=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_2=#}’
’${PV_NAME_SCALAR_2=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_2=16}’
’${DESC_SCALAR_2=}’
’${LOAD_DESC_SCALAR_2=}’
’${EGU_SCALAR_2=}’
’${LOAD_EGU_SCALAR_2=}’
’${HYST_SCALAR_2=}’
’${LOAD_HYST_SCALAR_2=}’
’${DRVL_SCALAR_2=}’
’${LOAD_DRVL_SCALAR_2=}’
’${DRVH_SCALAR_2=}’
’${LOAD_DRVH_SCALAR_2=}’
’${HOPR_SCALAR_2=}’
’${LOAD_HOPR_SCALAR_2=}’
’${LOPR_SCALAR_2=}’
’${LOAD_LOPR_SCALAR_2=}’
’${HIGH_SCALAR_2=}’
’${LOAD_HIGH_SCALAR_2=}’
’${HSV_SCALAR_2=}’
’${LOAD_HSV_SCALAR_2=}’
’${HIHI_SCALAR_2=}’
’${LOAD_HIHI_SCALAR_2=}’
’${HHSV_SCALAR_2=}’
’${LOAD_HHSV_SCALAR_2=}’
’${LOW_SCALAR_2=}’
’${LOAD_LOW_SCALAR_2=}’
’${LSV_SCALAR_2=}’
’${LOAD_LSV_SCALAR_2=}’
’${LOLO_SCALAR_2=}’
’${LOAD_LOLO_SCALAR_2=}’
’${LLSV_SCALAR_2=}’
’${LOAD_LLSV_SCALAR_2=}’
’${ADEL_SCALAR_2=}’
’${LOAD_ADEL_SCALAR_2=}’
’${MDEL_SCALAR_2=}’
’${LOAD_MDEL_SCALAR_2=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_2=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_2=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_2=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_2=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_2=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_2=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_2=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_2=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_2=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_2=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_2=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_2=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_2=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_2=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_2=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_2=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_2=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_2=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_2=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_2=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_2=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record4#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_3=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_3=#}’
’${PV_NAME_SCALAR_3=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_3=16}’
’${DESC_SCALAR_3=}’
’${LOAD_DESC_SCALAR_3=}’
’${EGU_SCALAR_3=}’
’${LOAD_EGU_SCALAR_3=}’
’${HYST_SCALAR_3=}’
’${LOAD_HYST_SCALAR_3=}’
’${DRVL_SCALAR_3=}’
’${LOAD_DRVL_SCALAR_3=}’
’${DRVH_SCALAR_3=}’
’${LOAD_DRVH_SCALAR_3=}’
’${HOPR_SCALAR_3=}’
’${LOAD_HOPR_SCALAR_3=}’
’${LOPR_SCALAR_3=}’
’${LOAD_LOPR_SCALAR_3=}’
’${HIGH_SCALAR_3=}’
’${LOAD_HIGH_SCALAR_3=}’
’${HSV_SCALAR_3=}’
’${LOAD_HSV_SCALAR_3=}’
’${HIHI_SCALAR_3=}’
’${LOAD_HIHI_SCALAR_3=}’
’${HHSV_SCALAR_3=}’
’${LOAD_HHSV_SCALAR_3=}’
’${LOW_SCALAR_3=}’
’${LOAD_LOW_SCALAR_3=}’
’${LSV_SCALAR_3=}’
’${LOAD_LSV_SCALAR_3=}’
’${LOLO_SCALAR_3=}’
’${LOAD_LOLO_SCALAR_3=}’
’${LLSV_SCALAR_3=}’
’${LOAD_LLSV_SCALAR_3=}’
’${ADEL_SCALAR_3=}’
’${LOAD_ADEL_SCALAR_3=}’
’${MDEL_SCALAR_3=}’
’${LOAD_MDEL_SCALAR_3=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_3=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_3=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_3=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_3=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_3=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_3=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_3=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_3=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_3=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_3=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_3=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_3=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_3=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_3=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_3=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_3=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_3=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_3=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_3=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_3=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_3=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record5#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_4=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_4=#}’
’${PV_NAME_SCALAR_4=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_4=16}’
’${DESC_SCALAR_4=}’
’${LOAD_DESC_SCALAR_4=}’
’${EGU_SCALAR_4=}’
’${LOAD_EGU_SCALAR_4=}’
’${HYST_SCALAR_4=}’
’${LOAD_HYST_SCALAR_4=}’
’${DRVL_SCALAR_4=}’
’${LOAD_DRVL_SCALAR_4=}’
’${DRVH_SCALAR_4=}’
’${LOAD_DRVH_SCALAR_4=}’
’${HOPR_SCALAR_4=}’
’${LOAD_HOPR_SCALAR_4=}’
’${LOPR_SCALAR_4=}’
’${LOAD_LOPR_SCALAR_4=}’
’${HIGH_SCALAR_4=}’
’${LOAD_HIGH_SCALAR_4=}’
’${HSV_SCALAR_4=}’
’${LOAD_HSV_SCALAR_4=}’
’${HIHI_SCALAR_4=}’
’${LOAD_HIHI_SCALAR_4=}’
’${HHSV_SCALAR_4=}’
’${LOAD_HHSV_SCALAR_4=}’
’${LOW_SCALAR_4=}’
’${LOAD_LOW_SCALAR_4=}’
’${LSV_SCALAR_4=}’
’${LOAD_LSV_SCALAR_4=}’
’${LOLO_SCALAR_4=}’
’${LOAD_LOLO_SCALAR_4=}’
’${LLSV_SCALAR_4=}’
’${LOAD_LLSV_SCALAR_4=}’
’${ADEL_SCALAR_4=}’
’${LOAD_ADEL_SCALAR_4=}’
’${MDEL_SCALAR_4=}’
’${LOAD_MDEL_SCALAR_4=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_4=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_4=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_4=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_4=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_4=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_4=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_4=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_4=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_4=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_4=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_4=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_4=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_4=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_4=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_4=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_4=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_4=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_4=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_4=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_4=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_4=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record6#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_5=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_5=#}’
’${PV_NAME_SCALAR_5=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_5=16}’
’${DESC_SCALAR_5=}’
’${LOAD_DESC_SCALAR_5=}’
’${EGU_SCALAR_5=}’
’${LOAD_EGU_SCALAR_5=}’
’${HYST_SCALAR_5=}’
’${LOAD_HYST_SCALAR_5=}’
’${DRVL_SCALAR_5=}’
’${LOAD_DRVL_SCALAR_5=}’
’${DRVH_SCALAR_5=}’
’${LOAD_DRVH_SCALAR_5=}’
’${HOPR_SCALAR_5=}’
’${LOAD_HOPR_SCALAR_5=}’
’${LOPR_SCALAR_5=}’
’${LOAD_LOPR_SCALAR_5=}’
’${HIGH_SCALAR_5=}’
’${LOAD_HIGH_SCALAR_5=}’
’${HSV_SCALAR_5=}’
’${LOAD_HSV_SCALAR_5=}’
’${HIHI_SCALAR_5=}’
’${LOAD_HIHI_SCALAR_5=}’
’${HHSV_SCALAR_5=}’
’${LOAD_HHSV_SCALAR_5=}’
’${LOW_SCALAR_5=}’
’${LOAD_LOW_SCALAR_5=}’
’${LSV_SCALAR_5=}’
’${LOAD_LSV_SCALAR_5=}’
’${LOLO_SCALAR_5=}’
’${LOAD_LOLO_SCALAR_5=}’
’${LLSV_SCALAR_5=}’
’${LOAD_LLSV_SCALAR_5=}’
’${ADEL_SCALAR_5=}’
’${LOAD_ADEL_SCALAR_5=}’
’${MDEL_SCALAR_5=}’
’${LOAD_MDEL_SCALAR_5=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_5=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_5=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_5=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_5=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_5=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_5=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_5=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_5=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_5=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_5=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_5=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_5=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_5=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_5=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_5=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_5=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_5=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_5=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_5=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_5=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_5=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record7#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_6=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_6=#}’
’${PV_NAME_SCALAR_6=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_6=16}’
’${DESC_SCALAR_6=}’
’${LOAD_DESC_SCALAR_6=}’
’${EGU_SCALAR_6=}’
’${LOAD_EGU_SCALAR_6=}’
’${HYST_SCALAR_6=}’
’${LOAD_HYST_SCALAR_6=}’
’${DRVL_SCALAR_6=}’
’${LOAD_DRVL_SCALAR_6=}’
’${DRVH_SCALAR_6=}’
’${LOAD_DRVH_SCALAR_6=}’
’${HOPR_SCALAR_6=}’
’${LOAD_HOPR_SCALAR_6=}’
’${LOPR_SCALAR_6=}’
’${LOAD_LOPR_SCALAR_6=}’
’${HIGH_SCALAR_6=}’
’${LOAD_HIGH_SCALAR_6=}’
’${HSV_SCALAR_6=}’
’${LOAD_HSV_SCALAR_6=}’
’${HIHI_SCALAR_6=}’
’${LOAD_HIHI_SCALAR_6=}’
’${HHSV_SCALAR_6=}’
’${LOAD_HHSV_SCALAR_6=}’
’${LOW_SCALAR_6=}’
’${LOAD_LOW_SCALAR_6=}’
’${LSV_SCALAR_6=}’
’${LOAD_LSV_SCALAR_6=}’
’${LOLO_SCALAR_6=}’
’${LOAD_LOLO_SCALAR_6=}’
’${LLSV_SCALAR_6=}’
’${LOAD_LLSV_SCALAR_6=}’
’${ADEL_SCALAR_6=}’
’${LOAD_ADEL_SCALAR_6=}’
’${MDEL_SCALAR_6=}’
’${LOAD_MDEL_SCALAR_6=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_6=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_6=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_6=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_6=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_6=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_6=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_6=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_6=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_6=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_6=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_6=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_6=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_6=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_6=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_6=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_6=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_6=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_6=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_6=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_6=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_6=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_6}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record8#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_7=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_7=#}’
’${PV_NAME_SCALAR_7=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_7=16}’
’${DESC_SCALAR_7=}’
’${LOAD_DESC_SCALAR_7=}’
’${EGU_SCALAR_7=}’
’${LOAD_EGU_SCALAR_7=}’
’${HYST_SCALAR_7=}’
’${LOAD_HYST_SCALAR_7=}’
’${DRVL_SCALAR_7=}’
’${LOAD_DRVL_SCALAR_7=}’
’${DRVH_SCALAR_7=}’
’${LOAD_DRVH_SCALAR_7=}’
’${HOPR_SCALAR_7=}’
’${LOAD_HOPR_SCALAR_7=}’
’${LOPR_SCALAR_7=}’
’${LOAD_LOPR_SCALAR_7=}’
’${HIGH_SCALAR_7=}’
’${LOAD_HIGH_SCALAR_7=}’
’${HSV_SCALAR_7=}’
’${LOAD_HSV_SCALAR_7=}’
’${HIHI_SCALAR_7=}’
’${LOAD_HIHI_SCALAR_7=}’
’${HHSV_SCALAR_7=}’
’${LOAD_HHSV_SCALAR_7=}’
’${LOW_SCALAR_7=}’
’${LOAD_LOW_SCALAR_7=}’
’${LSV_SCALAR_7=}’
’${LOAD_LSV_SCALAR_7=}’
’${LOLO_SCALAR_7=}’
’${LOAD_LOLO_SCALAR_7=}’
’${LLSV_SCALAR_7=}’
’${LOAD_LLSV_SCALAR_7=}’
’${ADEL_SCALAR_7=}’
’${LOAD_ADEL_SCALAR_7=}’
’${MDEL_SCALAR_7=}’
’${LOAD_MDEL_SCALAR_7=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_7=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_7=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_7=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_7=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_7=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_7=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_7=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_7=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_7=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_7=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_7=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_7=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_7=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_7=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_7=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_7=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_7=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_7=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_7=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_7=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_7=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_7}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record9#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_8=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_8=#}’
’${PV_NAME_SCALAR_8=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_8=16}’
’${DESC_SCALAR_8=}’
’${LOAD_DESC_SCALAR_8=}’
’${EGU_SCALAR_8=}’
’${LOAD_EGU_SCALAR_8=}’
’${HYST_SCALAR_8=}’
’${LOAD_HYST_SCALAR_8=}’
’${DRVL_SCALAR_8=}’
’${LOAD_DRVL_SCALAR_8=}’
’${DRVH_SCALAR_8=}’
’${LOAD_DRVH_SCALAR_8=}’
’${HOPR_SCALAR_8=}’
’${LOAD_HOPR_SCALAR_8=}’
’${LOPR_SCALAR_8=}’
’${LOAD_LOPR_SCALAR_8=}’
’${HIGH_SCALAR_8=}’
’${LOAD_HIGH_SCALAR_8=}’
’${HSV_SCALAR_8=}’
’${LOAD_HSV_SCALAR_8=}’
’${HIHI_SCALAR_8=}’
’${LOAD_HIHI_SCALAR_8=}’
’${HHSV_SCALAR_8=}’
’${LOAD_HHSV_SCALAR_8=}’
’${LOW_SCALAR_8=}’
’${LOAD_LOW_SCALAR_8=}’
’${LSV_SCALAR_8=}’
’${LOAD_LSV_SCALAR_8=}’
’${LOLO_SCALAR_8=}’
’${LOAD_LOLO_SCALAR_8=}’
’${LLSV_SCALAR_8=}’
’${LOAD_LLSV_SCALAR_8=}’
’${ADEL_SCALAR_8=}’
’${LOAD_ADEL_SCALAR_8=}’
’${MDEL_SCALAR_8=}’
’${LOAD_MDEL_SCALAR_8=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_8=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_8=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_8=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_8=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_8=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_8=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_8=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_8=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_8=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_8=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_8=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_8=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_8=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_8=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_8=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_8=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_8=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_8=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_8=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_8=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_8=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_8}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record10#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_9=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_9=#}’
’${PV_NAME_SCALAR_9=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_9=16}’
’${DESC_SCALAR_9=}’
’${LOAD_DESC_SCALAR_9=}’
’${EGU_SCALAR_9=}’
’${LOAD_EGU_SCALAR_9=}’
’${HYST_SCALAR_9=}’
’${LOAD_HYST_SCALAR_9=}’
’${DRVL_SCALAR_9=}’
’${LOAD_DRVL_SCALAR_9=}’
’${DRVH_SCALAR_9=}’
’${LOAD_DRVH_SCALAR_9=}’
’${HOPR_SCALAR_9=}’
’${LOAD_HOPR_SCALAR_9=}’
’${LOPR_SCALAR_9=}’
’${LOAD_LOPR_SCALAR_9=}’
’${HIGH_SCALAR_9=}’
’${LOAD_HIGH_SCALAR_9=}’
’${HSV_SCALAR_9=}’
’${LOAD_HSV_SCALAR_9=}’
’${HIHI_SCALAR_9=}’
’${LOAD_HIHI_SCALAR_9=}’
’${HHSV_SCALAR_9=}’
’${LOAD_HHSV_SCALAR_9=}’
’${LOW_SCALAR_9=}’
’${LOAD_LOW_SCALAR_9=}’
’${LSV_SCALAR_9=}’
’${LOAD_LSV_SCALAR_9=}’
’${LOLO_SCALAR_9=}’
’${LOAD_LOLO_SCALAR_9=}’
’${LLSV_SCALAR_9=}’
’${LOAD_LLSV_SCALAR_9=}’
’${ADEL_SCALAR_9=}’
’${LOAD_ADEL_SCALAR_9=}’
’${MDEL_SCALAR_9=}’
’${LOAD_MDEL_SCALAR_9=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_9=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_9=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_9=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_9=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_9=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_9=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_9=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_9=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_9=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_9=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_9=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_9=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_9=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_9=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_9=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_9=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_9=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_9=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_9=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_9=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_9=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_9}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record11#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_10=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_10=#}’
’${PV_NAME_SCALAR_10=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_10=16}’
’${DESC_SCALAR_10=}’
’${LOAD_DESC_SCALAR_10=}’
’${EGU_SCALAR_10=}’
’${LOAD_EGU_SCALAR_10=}’
’${HYST_SCALAR_10=}’
’${LOAD_HYST_SCALAR_10=}’
’${DRVL_SCALAR_10=}’
’${LOAD_DRVL_SCALAR_10=}’
’${DRVH_SCALAR_10=}’
’${LOAD_DRVH_SCALAR_10=}’
’${HOPR_SCALAR_10=}’
’${LOAD_HOPR_SCALAR_10=}’
’${LOPR_SCALAR_10=}’
’${LOAD_LOPR_SCALAR_10=}’
’${HIGH_SCALAR_10=}’
’${LOAD_HIGH_SCALAR_10=}’
’${HSV_SCALAR_10=}’
’${LOAD_HSV_SCALAR_10=}’
’${HIHI_SCALAR_10=}’
’${LOAD_HIHI_SCALAR_10=}’
’${HHSV_SCALAR_10=}’
’${LOAD_HHSV_SCALAR_10=}’
’${LOW_SCALAR_10=}’
’${LOAD_LOW_SCALAR_10=}’
’${LSV_SCALAR_10=}’
’${LOAD_LSV_SCALAR_10=}’
’${LOLO_SCALAR_10=}’
’${LOAD_LOLO_SCALAR_10=}’
’${LLSV_SCALAR_10=}’
’${LOAD_LLSV_SCALAR_10=}’
’${ADEL_SCALAR_10=}’
’${LOAD_ADEL_SCALAR_10=}’
’${MDEL_SCALAR_10=}’
’${LOAD_MDEL_SCALAR_10=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_10=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_10=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_10=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_10=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_10=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_10=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_10=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_10=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_10=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_10=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_10=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_10=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_10=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_10=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_10=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_10=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_10=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_10=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_10=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_10=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_10=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_10}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record12#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_11=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_11=#}’
’${PV_NAME_SCALAR_11=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_11=16}’
’${DESC_SCALAR_11=}’
’${LOAD_DESC_SCALAR_11=}’
’${EGU_SCALAR_11=}’
’${LOAD_EGU_SCALAR_11=}’
’${HYST_SCALAR_11=}’
’${LOAD_HYST_SCALAR_11=}’
’${DRVL_SCALAR_11=}’
’${LOAD_DRVL_SCALAR_11=}’
’${DRVH_SCALAR_11=}’
’${LOAD_DRVH_SCALAR_11=}’
’${HOPR_SCALAR_11=}’
’${LOAD_HOPR_SCALAR_11=}’
’${LOPR_SCALAR_11=}’
’${LOAD_LOPR_SCALAR_11=}’
’${HIGH_SCALAR_11=}’
’${LOAD_HIGH_SCALAR_11=}’
’${HSV_SCALAR_11=}’
’${LOAD_HSV_SCALAR_11=}’
’${HIHI_SCALAR_11=}’
’${LOAD_HIHI_SCALAR_11=}’
’${HHSV_SCALAR_11=}’
’${LOAD_HHSV_SCALAR_11=}’
’${LOW_SCALAR_11=}’
’${LOAD_LOW_SCALAR_11=}’
’${LSV_SCALAR_11=}’
’${LOAD_LSV_SCALAR_11=}’
’${LOLO_SCALAR_11=}’
’${LOAD_LOLO_SCALAR_11=}’
’${LLSV_SCALAR_11=}’
’${LOAD_LLSV_SCALAR_11=}’
’${ADEL_SCALAR_11=}’
’${LOAD_ADEL_SCALAR_11=}’
’${MDEL_SCALAR_11=}’
’${LOAD_MDEL_SCALAR_11=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_11=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_11=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_11=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_11=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_11=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_11=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_11=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_11=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_11=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_11=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_11=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_11=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_11=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_11=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_11=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_11=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_11=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_11=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_11=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_11=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_11=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_11}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record13#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_12=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_12=#}’
’${PV_NAME_SCALAR_12=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_12=16}’
’${DESC_SCALAR_12=}’
’${LOAD_DESC_SCALAR_12=}’
’${EGU_SCALAR_12=}’
’${LOAD_EGU_SCALAR_12=}’
’${HYST_SCALAR_12=}’
’${LOAD_HYST_SCALAR_12=}’
’${DRVL_SCALAR_12=}’
’${LOAD_DRVL_SCALAR_12=}’
’${DRVH_SCALAR_12=}’
’${LOAD_DRVH_SCALAR_12=}’
’${HOPR_SCALAR_12=}’
’${LOAD_HOPR_SCALAR_12=}’
’${LOPR_SCALAR_12=}’
’${LOAD_LOPR_SCALAR_12=}’
’${HIGH_SCALAR_12=}’
’${LOAD_HIGH_SCALAR_12=}’
’${HSV_SCALAR_12=}’
’${LOAD_HSV_SCALAR_12=}’
’${HIHI_SCALAR_12=}’
’${LOAD_HIHI_SCALAR_12=}’
’${HHSV_SCALAR_12=}’
’${LOAD_HHSV_SCALAR_12=}’
’${LOW_SCALAR_12=}’
’${LOAD_LOW_SCALAR_12=}’
’${LSV_SCALAR_12=}’
’${LOAD_LSV_SCALAR_12=}’
’${LOLO_SCALAR_12=}’
’${LOAD_LOLO_SCALAR_12=}’
’${LLSV_SCALAR_12=}’
’${LOAD_LLSV_SCALAR_12=}’
’${ADEL_SCALAR_12=}’
’${LOAD_ADEL_SCALAR_12=}’
’${MDEL_SCALAR_12=}’
’${LOAD_MDEL_SCALAR_12=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_12=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_12=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_12=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_12=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_12=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_12=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_12=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_12=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_12=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_12=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_12=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_12=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_12=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_12=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_12=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_12=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_12=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_12=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_12=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_12=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_12=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_12}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record14#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_13=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_13=#}’
’${PV_NAME_SCALAR_13=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_13=16}’
’${DESC_SCALAR_13=}’
’${LOAD_DESC_SCALAR_13=}’
’${EGU_SCALAR_13=}’
’${LOAD_EGU_SCALAR_13=}’
’${HYST_SCALAR_13=}’
’${LOAD_HYST_SCALAR_13=}’
’${DRVL_SCALAR_13=}’
’${LOAD_DRVL_SCALAR_13=}’
’${DRVH_SCALAR_13=}’
’${LOAD_DRVH_SCALAR_13=}’
’${HOPR_SCALAR_13=}’
’${LOAD_HOPR_SCALAR_13=}’
’${LOPR_SCALAR_13=}’
’${LOAD_LOPR_SCALAR_13=}’
’${HIGH_SCALAR_13=}’
’${LOAD_HIGH_SCALAR_13=}’
’${HSV_SCALAR_13=}’
’${LOAD_HSV_SCALAR_13=}’
’${HIHI_SCALAR_13=}’
’${LOAD_HIHI_SCALAR_13=}’
’${HHSV_SCALAR_13=}’
’${LOAD_HHSV_SCALAR_13=}’
’${LOW_SCALAR_13=}’
’${LOAD_LOW_SCALAR_13=}’
’${LSV_SCALAR_13=}’
’${LOAD_LSV_SCALAR_13=}’
’${LOLO_SCALAR_13=}’
’${LOAD_LOLO_SCALAR_13=}’
’${LLSV_SCALAR_13=}’
’${LOAD_LLSV_SCALAR_13=}’
’${ADEL_SCALAR_13=}’
’${LOAD_ADEL_SCALAR_13=}’
’${MDEL_SCALAR_13=}’
’${LOAD_MDEL_SCALAR_13=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_13=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_13=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_13=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_13=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_13=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_13=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_13=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_13=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_13=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_13=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_13=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_13=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_13=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_13=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_13=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_13=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_13=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_13=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_13=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_13=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_13=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_13}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record15#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_14=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_14=#}’
’${PV_NAME_SCALAR_14=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_14=16}’
’${DESC_SCALAR_14=}’
’${LOAD_DESC_SCALAR_14=}’
’${EGU_SCALAR_14=}’
’${LOAD_EGU_SCALAR_14=}’
’${HYST_SCALAR_14=}’
’${LOAD_HYST_SCALAR_14=}’
’${DRVL_SCALAR_14=}’
’${LOAD_DRVL_SCALAR_14=}’
’${DRVH_SCALAR_14=}’
’${LOAD_DRVH_SCALAR_14=}’
’${HOPR_SCALAR_14=}’
’${LOAD_HOPR_SCALAR_14=}’
’${LOPR_SCALAR_14=}’
’${LOAD_LOPR_SCALAR_14=}’
’${HIGH_SCALAR_14=}’
’${LOAD_HIGH_SCALAR_14=}’
’${HSV_SCALAR_14=}’
’${LOAD_HSV_SCALAR_14=}’
’${HIHI_SCALAR_14=}’
’${LOAD_HIHI_SCALAR_14=}’
’${HHSV_SCALAR_14=}’
’${LOAD_HHSV_SCALAR_14=}’
’${LOW_SCALAR_14=}’
’${LOAD_LOW_SCALAR_14=}’
’${LSV_SCALAR_14=}’
’${LOAD_LSV_SCALAR_14=}’
’${LOLO_SCALAR_14=}’
’${LOAD_LOLO_SCALAR_14=}’
’${LLSV_SCALAR_14=}’
’${LOAD_LLSV_SCALAR_14=}’
’${ADEL_SCALAR_14=}’
’${LOAD_ADEL_SCALAR_14=}’
’${MDEL_SCALAR_14=}’
’${LOAD_MDEL_SCALAR_14=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_14=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_14=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_14=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_14=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_14=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_14=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_14=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_14=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_14=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_14=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_14=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_14=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_14=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_14=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_14=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_14=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_14=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_14=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_14=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_14=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_14=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_14}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record16#
ai record called ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_15=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_SCALAR_15=#}’
’${PV_NAME_SCALAR_15=}’
Note that other macros can (as in optional) be specified:
’${PREC_SCALAR_15=16}’
’${DESC_SCALAR_15=}’
’${LOAD_DESC_SCALAR_15=}’
’${EGU_SCALAR_15=}’
’${LOAD_EGU_SCALAR_15=}’
’${HYST_SCALAR_15=}’
’${LOAD_HYST_SCALAR_15=}’
’${DRVL_SCALAR_15=}’
’${LOAD_DRVL_SCALAR_15=}’
’${DRVH_SCALAR_15=}’
’${LOAD_DRVH_SCALAR_15=}’
’${HOPR_SCALAR_15=}’
’${LOAD_HOPR_SCALAR_15=}’
’${LOPR_SCALAR_15=}’
’${LOAD_LOPR_SCALAR_15=}’
’${HIGH_SCALAR_15=}’
’${LOAD_HIGH_SCALAR_15=}’
’${HSV_SCALAR_15=}’
’${LOAD_HSV_SCALAR_15=}’
’${HIHI_SCALAR_15=}’
’${LOAD_HIHI_SCALAR_15=}’
’${HHSV_SCALAR_15=}’
’${LOAD_HHSV_SCALAR_15=}’
’${LOW_SCALAR_15=}’
’${LOAD_LOW_SCALAR_15=}’
’${LSV_SCALAR_15=}’
’${LOAD_LSV_SCALAR_15=}’
’${LOLO_SCALAR_15=}’
’${LOAD_LOLO_SCALAR_15=}’
’${LLSV_SCALAR_15=}’
’${LOAD_LLSV_SCALAR_15=}’
’${ADEL_SCALAR_15=}’
’${LOAD_ADEL_SCALAR_15=}’
’${MDEL_SCALAR_15=}’
’${LOAD_MDEL_SCALAR_15=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "ai"#
Specifies the type of the record, which is ‘ai’ (analog input). See https://web.archive.org/web/20210325091143/https://epics.anl.gov/base/R7-0/4-docs/aiRecord.html for more details about the ai record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_SCALAR_15=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_SCALAR_15=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_SCALAR_15=}’ macro which defaults to ‘’ (nothing).
-
static str PREC = "${PREC_SCALAR_15=16}"#
Specifies the floating point precision (i.e. the number of digits to show after the decimal point) with which to display the value of the PV implementing this record.
-
static str DESC = "${DESC_SCALAR_15=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str EGU = "${EGU_SCALAR_15=}"#
Specifies the engineering units associated to the value of this record.
This field is optional, it will be “loaded” only if the ‘${LOAD_EGU_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HYST = "${HYST_SCALAR_15=}"#
Specifies the hysteresis to prevent alarm chattering from an input signal that is close to one of the limits and suffers from significant readout noise.
This field is optional, it will be “loaded” only if the ‘${LOAD_HYST_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVL = "${DRVL_SCALAR_15=}"#
Specifies the drive low limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVL_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str DRVH = "${DRVH_SCALAR_15=}"#
Specifies the drive high limit so that value is now clipped to the range DRVL to DRVH inclusive, provided that DRVH > DRVL.
This field is optional, it will be “loaded” only if the ‘${LOAD_DRVH_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HOPR = "${HOPR_SCALAR_15=}"#
Specifies the high operating range, which is the upper display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as an upper limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_HOPR_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOPR = "${LOPR_SCALAR_15=}"#
Specifies the low operating range, which is the lower display limits for the value of this record. If this field is defined, it must be in the range: DRVL <= LOPR <= HOPR <= DRVH. If so, it will act as a lower limit fort the VAL, HIHI, HIGH, LOW and LOLO fields, but only for client display.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOPR_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIGH = "${HIGH_SCALAR_15=}"#
Specifies the high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIGH_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HSV = "${HSV_SCALAR_15=}"#
Specifies the severity associated to the previsous ‘HIGH’ field (high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HSV_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HIHI = "${HIHI_SCALAR_15=}"#
Specifies the high-high alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_HIHI_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str HHSV = "${HHSV_SCALAR_15=}"#
Specifies the severity associated to the previsous ‘HIHI’ field (high high alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_HHSV_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOW = "${LOW_SCALAR_15=}"#
Specifies the low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOW_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LSV = "${LSV_SCALAR_15=}"#
Specifies the severity associated to the previsous ‘LOW’ field (low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LSV_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LOLO = "${LOLO_SCALAR_15=}"#
Specifies the low-low alarm limit threshold.
This field is optional, it will be “loaded” only if the ‘${LOAD_LOLO_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str LLSV = "${LLSV_SCALAR_15=}"#
Specifies the severity associated to the previsous ‘LOLO’ field (low low alarm limit threshold).
This field is optional, it will be “loaded” only if the ‘${LOAD_LLSV_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str ADEL = "${ADEL_SCALAR_15=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_ADEL_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
static str MDEL = "${MDEL_SCALAR_15=}"#
Specifies the deadband for archive monitors. ADEL and MDEL fields specify a minimum delta which a changing value must surpass before the value-change monitors are invoked. If these fields have a value of zero, every time the value changes, a monitor will be triggered; if they have a value of -1, every time the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors.
This field is optional, it will be “loaded” only if the ‘${LOAD_MDEL_SCALAR_15}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record17#
waveform record called ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_1=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_STRING_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_STRING_1=#}’
’${PV_NAME_STRING_1=}’
Note that other macros can (as in optional) be specified:
’${STRING_1_RESULT_MAX_LENGTH}’
’${DESC_STRING_1=}’
’${LOAD_DESC_STRING_1=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "waveform"#
Specifies the type of the record, which is ‘waveform’. See https://web.archive.org/web/20240724090613/https://epics.anl.gov/base/R7-0/4-docs/waveformRecord.html for more details about the waveform record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_STRING_1=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_1=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_STRING_1=}’ macro which defaults to ‘’ (nothing).
-
static str FTVL = "CHAR"#
Specifies the type of data stored in the waveform. Here, this is a waveform of characters (‘CHAR’s).
-
static str NELM = "${STRING_1_RESULT_MAX_LENGTH=1024}"#
Specifies the maximum size of the waveform. It defaults to 1024.
-
static str DESC = "${DESC_STRING_1=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_STRING_1}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record18#
waveform record called ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_2=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_STRING_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_STRING_2=#}’
’${PV_NAME_STRING_2=}’
Note that other macros can (as in optional) be specified:
’${STRING_2_RESULT_MAX_LENGTH}’
’${DESC_STRING_2=}’
’${LOAD_DESC_STRING_2=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "waveform"#
Specifies the type of the record, which is ‘waveform’. See https://web.archive.org/web/20240724090613/https://epics.anl.gov/base/R7-0/4-docs/waveformRecord.html for more details about the waveform record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_STRING_2=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_2=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_STRING_2=}’ macro which defaults to ‘’ (nothing).
-
static str FTVL = "CHAR"#
Specifies the type of data stored in the waveform. Here, this is a waveform of characters (‘CHAR’s).
-
static str NELM = "${STRING_2_RESULT_MAX_LENGTH=1024}"#
Specifies the maximum size of the waveform. It defaults to 1024.
-
static str DESC = "${DESC_STRING_2=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_STRING_2}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record19#
waveform record called ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_3=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_STRING_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_STRING_3=#}’
’${PV_NAME_STRING_3=}’
Note that other macros can (as in optional) be specified:
’${STRING_3_RESULT_MAX_LENGTH}’
’${DESC_STRING_3=}’
’${LOAD_DESC_STRING_3=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "waveform"#
Specifies the type of the record, which is ‘waveform’. See https://web.archive.org/web/20240724090613/https://epics.anl.gov/base/R7-0/4-docs/waveformRecord.html for more details about the waveform record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_STRING_3=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_3=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_STRING_3=}’ macro which defaults to ‘’ (nothing).
-
static str FTVL = "CHAR"#
Specifies the type of data stored in the waveform. Here, this is a waveform of characters (‘CHAR’s).
-
static str NELM = "${STRING_3_RESULT_MAX_LENGTH=1024}"#
Specifies the maximum size of the waveform. It defaults to 1024.
-
static str DESC = "${DESC_STRING_3=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_STRING_3}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record20#
waveform record called ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_4=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_STRING_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_STRING_4=#}’
’${PV_NAME_STRING_4=}’
Note that other macros can (as in optional) be specified:
’${STRING_4_RESULT_MAX_LENGTH}’
’${DESC_STRING_4=}’
’${LOAD_DESC_STRING_4=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "waveform"#
Specifies the type of the record, which is ‘waveform’. See https://web.archive.org/web/20240724090613/https://epics.anl.gov/base/R7-0/4-docs/waveformRecord.html for more details about the waveform record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_STRING_4=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_4=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_STRING_4=}’ macro which defaults to ‘’ (nothing).
-
static str FTVL = "CHAR"#
Specifies the type of data stored in the waveform. Here, this is a waveform of characters (‘CHAR’s).
-
static str NELM = "${STRING_4_RESULT_MAX_LENGTH=1024}"#
Specifies the maximum size of the waveform. It defaults to 1024.
-
static str DESC = "${DESC_STRING_4=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_STRING_4}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record21#
waveform record called ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_5=}’, and used to hold the result of a shell instruction send through an SSH command.
This record is optional, it will be “loaded” only if the ‘${LOAD_STRING_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes every line of this record, and this macro substitution defaults to ‘#’, which comments the whole record by default.
Note that some macros are expected, they have no default value so they must (as in mandatory) be specified:
’${PREFIX}’
’${CATEGORY}’
Note that other macros can (as in optional) be specified, but they have to be specified if you intend to “load” this record:
’${LOAD_STRING_5=#}’
’${PV_NAME_STRING_5=}’
Note that other macros can (as in optional) be specified:
’${STRING_5_RESULT_MAX_LENGTH}’
’${DESC_STRING_5=}’
’${LOAD_DESC_STRING_5=}’
For more details about all those macros, you can check the reference file called ‘.cmd, .substitutions and .template references’ (in particular: check the
.substitutionssection).Public Static Attributes
-
static str TYPE = "waveform"#
Specifies the type of the record, which is ‘waveform’. See https://web.archive.org/web/20240724090613/https://epics.anl.gov/base/R7-0/4-docs/waveformRecord.html for more details about the waveform record type.
-
static str NAME = "${PREFIX}${CATEGORY}${PV_NAME_STRING_5=}"#
Specifies the name of the record, which is ‘${PREFIX}${CATEGORY}${PV_NAME_STRING_5=}’. The name of this record will depend on the ‘${PREFIX}’ macro, the ‘${CATEGORY}’ macro, and the ‘${PV_NAME_STRING_5=}’ macro which defaults to ‘’ (nothing).
-
static str FTVL = "CHAR"#
Specifies the type of data stored in the waveform. Here, this is a waveform of characters (‘CHAR’s).
-
static str NELM = "${STRING_5_RESULT_MAX_LENGTH=1024}"#
Specifies the maximum size of the waveform. It defaults to 1024.
-
static str DESC = "${DESC_STRING_5=}"#
Describes the record briefly.
This field is optional, it will be “loaded” only if the ‘${LOAD_DESC_STRING_5}’ macro substitution is set to ‘’ (nothing). Indeed, this macro substitution prefixes this field, and this macro substitution defaults to ‘#’, which comments the field by default (see “comment-macro” in the glossary).
-
class record0#