Talk:WeibullEvents.GetDistrParameters/Notes

DRAFT

Member of: SynthesisAPI.WeibullEvents

Displays a prompt for entering customized parameters. This is called when the Calculate method is called and there is insufficient data to fit a model.

Syntax

• GetDistrParameters( sender As WeibullDataSet, sMsg As String , GetOnlyOneParameter As Boolean , Params As List( Of ParamInputInfo ) , Cancel As Boolean)

Parameters

sender: A WeibullDataSet object.

sMsg: The main display label.

GetOnlyOneParameter: The prompt for only one parameter.

Params: A list of ParamInputInfo objects that would be updated by this prompt. After processing with this event handler, the Value of each ParamInputInfo object will be updated.

Cancel: If the prompt was closed by any means other than clicking "Okay," this value will be set to True.

Usage Example

 'Overrides requested. Create a new class, inherit WeibullEvents, and set the dataset's events. 
 Private Class myEvents
     Inherits WeibullEvents
     Public Overrides Sub GetDistrParameters(sender As WeibullDataSet, sMsg As String, 
     GetOnlyOneParamater As Boolean, Params As List(Of ParamInputInfo), ByRef Cancel As Boolean)
         MyBase.GetDistrParameters(sender, sMsg, GetOnlyOneParamater, Params, Cancel)
         MessageBox.Show("Additional overridden code here.")
     End Sub
 End Class
 
 'Declare the WeibullDataSet. 
 Dim WDS as New WeibullDataSet
 
 'Use the created myEvents class in place of the one created by the dataset. 
 WDS.Events = New myEvents
 
 'Creates a new list of ParamInputInfo objects. Populate the list. 
 Dim Params As New List(Of ParamInputInfo)
 Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))
 Params.Add(New ParamInputInfo("Param2", 0, Double.MaxValue, False, True))
 
 'Create a Boolean for return of "Cancel" parameter. 
 Dim wasCanceled As Boolean
 
 'Prompt user to input the parameters. 
 WDS.Events.GetDistrParameters(WDS, "Message1", True, Params, wasCanceled)
 
 'The new Parameter values are in their respective ParamInputInfo.Value variables. 
 Dim NewParameter1value As Double
 Dim NewParameter2value As Double 
 If Not wasCanceled Then
      NewParameter1value = Params(0).Value
      NewParameter2value = Params(1).Value
 End If