RRM 3-13 String Calcout - Revision history

TimMooney at 15:11, 9 June 2006

2006-06-09T15:11:39Z

← Older revision		Revision as of 15:11, 9 June 2006
Line 118:		Line 118:
	* The constants S2R (arc-seconds-to-radians) and R2S are supported.		* The constants S2R (arc-seconds-to-radians) and R2S are supported.
	* <font color="blue">The functions MIN() and MAX() may have more than two arguments.</font>		* <font color="blue">The functions MIN() and MAX() may have more than two arguments.</font>
	* The function NINT() (nearest integer) is supported.
	* The function LN() (log base e) is a permitted alternative to LOGE()
	* The function ATAN2() (alternative form of the arctangent function) is supported
	* <font color="blue">The binary operators '>&' (larger of the operands) and '<&' (smaller) are supported.</font>		* <font color="blue">The binary operators '>&' (larger of the operands) and '<&' (smaller) are supported.</font>
	* The binary ~~operators '==' (equal) and~~ '!=' (not equal) ~~are~~ permitted alternatives ~~to '=' and~~ '#'~~, respectively~~.		* The binary operator '!=' (not equal) is a permitted alternatives '#'.
	* The unary operator '@' selects an input field by number. (E.g., '@0' means 'A'. If 'B' has the value 3, '@b' means 'D'.)		* The unary operator '@' selects an input field by number. (E.g., '@0' means 'A'. If 'B' has the value 3, '@b' means 'D'.)
	* The values of the variables A...L used in expressions may be the results of previously evaluated expressions.

	Expressions supported by the sCalcout record can involve operands, algebraic operators and functions, trigonometric functions, relational operators, logical operators, string operators and functions, parentheses and commas, and the conditional '?:' operator. Numeric and string operands are supported, and		Expressions supported by the sCalcout record can involve operands, algebraic operators and functions, trigonometric functions, relational operators, logical operators, string operators and functions, parentheses and commas, and the conditional '?:' operator. Numeric and string operands are supported, and

TimMooney at 22:11, 8 June 2006

2006-06-08T22:11:38Z

← Older revision		Revision as of 22:11, 8 June 2006
Line 902:		Line 902:
	<tr><td valign=top>		<tr><td valign=top>
	<TT>Every Time</TT><td valign=top>write output every time record is processed.		<TT>Every Time</TT><td valign=top>write output every time record is processed.


	<tr><td valign=top>		<tr><td valign=top>
	<TT>On Change</TT><td valign=top>write output every time VAL changes, i.e., every		<TT>On Change</TT><td valign=top>write output every time VAL changes, i.e., every time the result of the expression changes.
	time the result of the expression changes.


	<tr><td valign=top>		<tr><td valign=top>
	<TT>When Zero</TT><td valign=top>when record is processed, write output if VAL is		<TT>When Zero</TT><td valign=top>when record is processed, write output if VAL is zero.
	zero.


	<tr><td valign=top>		<tr><td valign=top>
	<TT>When Non-zero</TT><td valign=top>when record is processed, write output if VAL		<TT>When Non-zero</TT><td valign=top>when record is processed, write output if VAL is non-zero.
	is non-zero.


	<tr><td valign=top>		<tr><td valign=top>
	<TT>Transition to Zero</TT><td valign=top>when record is processed, write output only		<TT>Transition to Zero</TT><td valign=top>when record is processed, write output only if VAL is zero and last value was non-zero.
	if VAL is zero and last value was non-zero.


	<tr><td valign=top>		<tr><td valign=top>
	<TT>Transition to Non-zero</TT><td valign=top>when record is processed, write output		<TT>Transition to Non-zero</TT><td valign=top>when record is processed, write output only if VAL is non-zero and last value was zero.
	only if VAL is non-zero and last value was zero.

	<tr><td valign=top>		<tr><td valign=top>
Line 1,104:		Line 1,094:
	<TD><font color="blue">No</font></TD>		<TD><font color="blue">No</font></TD>
	</TR>		</TR>
	~~</font>~~
	</TABLE>		</TABLE>

Line 1,797:		Line 1,786:
	# Fetch values from all valid input links.		# Fetch values from all valid input links.
	# Call sCalcPerform(), which evaluates the expression specified in CALC and stores the result in VAL. If sCalcPerform() returns success, UDF is set to FALSE.		# Call sCalcPerform(), which evaluates the expression specified in CALC and stores the result in VAL. If sCalcPerform() returns success, UDF is set to FALSE.
	#Check alarms. This routine checks to see if the new VAL causes the alarm		#Check alarms. This routine checks to see if the new VAL causes the alarm status and severity to change. If so, NSEV, NSTA and LALM are set. It also honors the alarm hysteresis factor (HYST). Thus the value must change by at least HYST before the alarm status and severity changes.
	status and severity to change. If so, NSEV, NSTA and LALM are set. It also		# Determine if the Output Execution Option (OOPT) is met. If it is met, either execute the output link (and output event) immediately (if ODLY=0), or schedule a callback to do so after the specified interval. See the explanation for the <TT>execOutput()</TT> routine below.
	honors the alarm hysteresis factor (HYST). Thus the value must change by
	at least HYST before the alarm status and severity changes.
	# Determine if the Output Execution Option (OOPT) is met. If it is met,
	either execute the output link (and output event) immediately (if ODLY
	= 0), or schedule a callback to do so after the specified interval. See the
	explanation for the <TT>execOutput()</TT> routine below.
	# Determine what fields should be posted, and with what attributes.		# Determine what fields should be posted, and with what attributes.
	## Post all fields the record has changed.		## Post all fields the record has changed.
	## Alarm monitors are invoked if the alarm status or severity has changed.		## Alarm monitors are invoked if the alarm status or severity has changed.
	## Archive and value change monitors are invoked if ADEL and MDEL conditions		## Archive and value change monitors are invoked if ADEL and MDEL conditions are met.
	are met.
	## NSEV and NSTA are reset to 0		## NSEV and NSTA are reset to 0
	# <font color="blue">Call device support to</font> execute output link.		# <font color="blue">Call device support to</font> execute output link.
	# ~~Execute~~ the forward link, set PACT FALSE, and return.		# If we're not waiting for the output delay to expire, or for a completion callback, process the forward link, set PACT FALSE, and return.

	==== special ====		==== special ====
Line 1,857:		Line 1,839:
	# If the Alarm Severity is INVALID, follow the option as designated by the field IVOA.		# If the Alarm Severity is INVALID, follow the option as designated by the field IVOA.
	# If the Alarm Severity is not INVALID or IVOA specifies "Continue Normally", <font color="blue">call device support to</font> write the value of OVAL to <font color="blue">device or</font> PV specified by the OUT link, and post the event in OEVT (if non-zero).		# If the Alarm Severity is not INVALID or IVOA specifies "Continue Normally", <font color="blue">call device support to</font> write the value of OVAL to <font color="blue">device or</font> PV specified by the OUT link, and post the event in OEVT (if non-zero).
	~~# If an output delay was implemented, process the forward link.~~

	== Availability ==		== Availability ==

TimMooney at 21:53, 8 June 2006

2006-06-08T21:53:12Z

← Older revision		Revision as of 21:53, 8 June 2006
Line 639:		Line 639:
	<td align=center valign=top>MAX		<td align=center valign=top>MAX
	<td>Maximum lexically (two<font color="blue">-or-more</font>-argument function)		<td>Maximum lexically (two<font color="blue">-or-more</font>-argument function)
	<td><code>MAX('a','b') </code>→<code> 'c'</code>		<td><code>MAX('a','b') </code>→<code> 'b'</code>

	<tr>		<tr>

TimMooney at 21:50, 8 June 2006

2006-06-08T21:50:52Z

← Older revision		Revision as of 21:50, 8 June 2006
Line 1:		Line 1:
	= sCalcout Record =		= sCalcout Record =

	<i>This page actually describes the EPICS-3.14-compatible version of the sCalcout record. Text that does not apply to the 3.13-compatible version is rendered in <font color="blue">blue</font>. Documentation of the 3.13-compatible version is currently not available in this format, but may be found in the 'std' module of a 3.13-compatible synApps package.</i>		<i>This page actually describes the EPICS-3.14-compatible version of the sCalcout record. Text that does not apply to the 3.13-compatible version is rendered in <font color="blue">blue</font>. Documentation specific to the 3.13-compatible version is currently not available in this format, but may be found in the 'std' module of a 3.13-compatible synApps package.</i>

	The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions and operands. The record has 12 string fields (AA...LL) used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and ~~can produce~~ string results. The record's output link writes string or numeric data depending on the data type of the field to which it is linked.		The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions and operands. The record has 12 numeric fields (A...L) and 12 string fields (AA...LL), which are used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and produces both numeric and string results, in the VAL and SVAL fields, respectively. The record's output link writes string or numeric data, depending on the data type of the field to which it is linked.

	== Parameter Fields ==		== Parameter Fields ==

TimMooney: Distinguish 3.14 from 3.13 with color

2006-06-08T21:23:58Z

Distinguish 3.14 from 3.13 with color

Show changes

TimMooney: /* Expression Parameters */

2006-06-08T18:31:54Z

Expression Parameters

← Older revision		Revision as of 18:31, 8 June 2006
Line 114:		Line 114:
	In simple cases, OCAL is ignorable. It's use will be described later, in [[Output Parameters]].		In simple cases, OCAL is ignorable. It's use will be described later, in [[Output Parameters]].

	sCalcout-record expressions are very similar to Calcout-record ~~expression described elsewhere in this manual~~. But ~~instead~~ of the standard EPICS calc engine (which does not support string fields or operations), sCalcout-record ~~expressions are handled by~~ the sCalc engine, a separate piece of software ~~that~~ normally is distributed ~~along~~ with the sCalcout record. The differences between these engines that matter for numeric expressions are the following:		sCalcout-record expressions are very similar to standard EPICS Calc expressions, such as those used with the Calcout record. But in place of the standard EPICS calc engine (which does not support string fields or operations), sCalcout-record uses the <i>sCalc</i> engine, a separate piece of software, which normally is [[#Availability\|distributed]] with the sCalcout record. The differences between these engines that matter for numeric expressions are the following:

	* The constants PI (3.14159...), D2R (PI/180), R2D (180/PI), S2R (D2R/360), and R2S (1/S2R) are supported		* The constants PI (3.14159...), D2R (PI/180), R2D (180/PI), S2R (D2R/360), and R2S (1/S2R) are supported

TimMooney: Added table of expression parameters

2006-06-08T18:25:00Z

Added table of expression parameters

← Older revision		Revision as of 18:25, 8 June 2006
Line 44:		Line 44:

	=== Expression Parameters ===		=== Expression Parameters ===

			<TABLE BORDER>

			<TR>
			<TH>Field</TH>
			<TH>Summary</TH>
			<TH>Type</TH>
			<TH>DCT</TH>
			<TH>Initial</TH>
			<TH>Access</TH>
			<TH>Modify</TH>
			<TH>Rec Proc Monitor</TH>
			<TH>PP</TH>
			</TR>

			<TR>
			<TD>CALC</TD>
			<TD>Infix expression</TD>
			<TD>String[40]</TD>
			<TD>Yes</TD>
			<TD>""</TD>
			<TD>Yes</TD>
			<TD>Yes</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			</TR>

			<TR>
			<TD>CLCV</TD>
			<TD>CALC Valid</TD>
			<TD>Long</TD>
			<TD>No</TD>
			<TD>0</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			</TR>

			<TR>
			<TD>OCAL</TD>
			<TD>Infix expression</TD>
			<TD>String[40]</TD>
			<TD>Yes</TD>
			<TD>""</TD>
			<TD>Yes</TD>
			<TD>Yes</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			</TR>

			<TR>
			<TD>OCLV</TD>
			<TD>OCAL Valid</TD>
			<TD>Long</TD>
			<TD>No</TD>
			<TD>0</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			<TD>Yes</TD>
			<TD>No</TD>
			</TR>
			</TABLE>

	Like the Calcout record, the sCalcout record has the fields CALC and OCAL, in which the developer or user can enter an infix expression to be evaluated when the record is processed. The numeric value resulting from evaluation of CALC will be placed in the VAL field, and the resulting string value will be placed in the SVAL field. VAL can then be used by the OOPT field (see [[Output Parameters]]) to determine whether or not to write to the output link or post an output event. Either VAL and SVAL can also be written to the output link. (If you elect to write an output value, the record will choose between VAL and SVAL, depending on the data type of the field at the other end of the output link.)		Like the Calcout record, the sCalcout record has the fields CALC and OCAL, in which the developer or user can enter an infix expression to be evaluated when the record is processed. The numeric value resulting from evaluation of CALC will be placed in the VAL field, and the resulting string value will be placed in the SVAL field. VAL can then be used by the OOPT field (see [[Output Parameters]]) to determine whether or not to write to the output link or post an output event. Either VAL and SVAL can also be written to the output link. (If you elect to write an output value, the record will choose between VAL and SVAL, depending on the data type of the field at the other end of the output link.)
Line 826:		Line 889:
	@(A+B)		@(A+B)
	:Result is the value of the numeric variable whose number is given by the sum of A and B.		:Result is the value of the numeric variable whose number is given by the sum of A and B.


	=== Output Parameters ===		=== Output Parameters ===

TimMooney at 21:47, 7 June 2006

2006-06-07T21:47:33Z

← Older revision		Revision as of 21:47, 7 June 2006
Line 1:		Line 1:
	= sCalcout Record =		= sCalcout Record =

	<i>This page actually describes the EPICS-3.14-compatible version of the sCalcout record. Documentation of the 3.13-compatible version ~~are~~ currently not available in this format, but may be found in the 'std' module of a 3.13-compatible synApps package.</i>		<i>This page actually describes the EPICS-3.14-compatible version of the sCalcout record. Documentation of the 3.13-compatible version is currently not available in this format, but may be found in the 'std' module of a 3.13-compatible synApps package.</i>

	The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions in addition to numeric expressions. The record has 12 string fields (AA...LL) used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and can produce string results. The record's output link writes string or numeric data depending on the data type of the field to which it is linked.		The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions in addition to numeric expressions. The record has 12 string fields (AA...LL) used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and can produce string results. The record's output link writes string or numeric data depending on the data type of the field to which it is linked.

TimMooney at 21:46, 7 June 2006

2006-06-07T21:46:57Z

← Older revision		Revision as of 21:46, 7 June 2006
Line 1:		Line 1:
	= sCalcout Record =		= sCalcout Record =

			<i>This page actually describes the EPICS-3.14-compatible version of the sCalcout record. Documentation of the 3.13-compatible version are currently not available in this format, but may be found in the 'std' module of a 3.13-compatible synApps package.</i>

	The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions in addition to numeric expressions. The record has 12 string fields (AA...LL) used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and can produce string results. The record's output link writes string or numeric data depending on the data type of the field to which it is linked.		The String Calculation Output or "sCalcout" record is derived from the Calcout record and extends it by supporting string expressions in addition to numeric expressions. The record has 12 string fields (AA...LL) used as input variables for the expression. It calls an extended version of the EPICS calculation engine that accepts string arguments, supports a variety of string functions, and can produce string results. The record's output link writes string or numeric data depending on the data type of the field to which it is linked.
Line 1,791:		Line 1,793:
	==== execOutput() ====		==== execOutput() ====

	# If DOPT field specifies the use of OCAL, call the routine sCalcPerform		# If DOPT field specifies the use of OCAL, call the routine sCalcPerform for the postfix version of the expression in OCAL. Otherwise, use VAL.
	for the postfix version of the expression in OCAL. Otherwise, use VAL.		# If the Alarm Severity is INVALID, follow the option as designated by the field IVOA.
			# If the Alarm Severity is not INVALID or IVOA specifies "Continue Normally", call device support to write the value of OVAL to device or PV specified by the OUT link, and post the event in OEVT (if non-zero).

	# If the Alarm Severity is INVALID, follow the option as designated by
	the field IVOA.

	# If the Alarm Severity is not INVALID or IVOA specifies "Continue Normally",
	call device support to write the value of OVAL to device or PV specified by
	the OUT link, and post the event in OEVT (if non-zero).

	# If an output delay was implemented, process the forward link.		# If an output delay was implemented, process the forward link.

TimMooney at 21:39, 7 June 2006

2006-06-07T21:39:26Z

← Older revision		Revision as of 21:39, 7 June 2006
Line 186:		Line 186:
	</TABLE>		</TABLE>

	Legend: * If a ~~valid~~ input link is associated with this field, then it may		Legend: * If a non-blank input link is associated with this field, then it may
	not be modified.		not be modified. This is true even if the input link is invalid (in which case, the value will be 0, for a numeric field, or "Huh?", for a string field).

	There are a few special operands not associated with input fields, but		There are a few special operands not associated with input fields, but
Line 801:		Line 801:

	"abcdef"["ab","ef"]		"abcdef"["ab","ef"]
	:Result is "cd". (If the first argument is a string, it returns the index of the first character after a successful match, or the first character in the string if no match was found. If the second argument is a string, it returns the index of the last character before a successful match, or the last character in the string if no match was found.)		:Result is "cd". (If the first argument is a string, it returns the index of the first character after a successful match, or the first character in the string if no match was found. If the second argument is a string, it returns the index of the last character before a successful match, or the last character in the string if no match was found.) In other words, string arguments <i>delimit</i> the substring they are specifying without participating in it.)

	A==2 ? "yes" : "no"		A==2 ? "yes" : "no"