Scripting > Math Functions


Select a Paired Data Curve by Curve Label

setCurve(string curveName)

 

Select, by curve label, the paired data curve for performing subsequent arithmetic operations or math functions.  By default, a paired data set loaded from file has all curves selected.

 

A paired data set may contain more than one set of y-values.  However, a user may wish to modify only one curve of the data set.  For example, using the function ".add( 2.0 )" would by default add 2.0 to all y-values for all curves.  The setCurve() call may be used to limit the operation to just one selected set of y-values. 

 

The function searches the paired data set list of curve labels for a match to curveName.  If a match is found, that curve is set as the selected curve.

 

See also:  setCurve( integer curveNumber )

 

Parameters:

curveName – The curve label (a string) to set as the selected curve.

Example: damageCurve.setCurve(“RESIDENTIAL”)

Returns: Nothing

Generated Exceptions: Throws a HecMathException – if curveName is not found in the paired data set curve labels.