CLsqFit:GetErrMsg

CLsqFit:GetErrMsg

The GetErrMsg method returns a message describing the error in the least squares fit. If Fit returns false, use this method along with GetErrChan to obtain error information.

Syntax

sMsg = CLsqFit:GetErrMsg()

sMsg is a string containing the error message.
nChannel is an optional parameter containing the channel where the error occurred. This is useful only if fitting multi-channel data.

Example

The following script configures the fit but forgets to add any data points. After the fit fails, the script prints an error message and exits.

L = CLsqFit:new()	-- create a CLsqFit object
L:SetNumCoefs( 2 )	-- specify the number of coefficients
	-- forget to add data points
bSuccess = L:Fit()	-- do the fit
if not bSuccess then	-- test whether the fit succeeded
n = L:GetErrChan()	-- get the error channel
s = L:GetErrMsg(n)	-- get the error message
Exit( Sprintf("Error [%d] %s\n", n, s ) )	-- exit the script and list the error message
end	-- end of test block

Syntax

Example

Related Topics