WeibullDataSet.GetDistrParameters: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Member of: SynthesisAPI.WeibullDataSet

Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.

Remarks: To hide the messages or write your own code for the event procedure, set the UseEvents property of the object to True. The event is raised by the class methods.

Syntax

_GetDistrParameters(sMsg, InputInfo, ByRef Cancel)

Parameters

sMsg

Required. String. The message to display.

InputInfo

Required. An array of DistrParametersInput() type objects that represent the model's parameters.

Cancel

Required. Boolean. Indicates whether the input was cancelled. Default value = False.

Example

The following example provides a simple demonstration on how to customize the event procedure.

VBA
 
 'Specify a variable to handle the event. 
  Private WithEvents wds As WeibullDataSet

 '----------------------------  
 Private Sub Main()
   'Associate the event variable with an object. 
    Set wds = New WeibullDataSet

   'Set the application to use your event procedure. 
    wds.UseEvents = True

   'To trigger the event, call the Calculate method without defining a data set.  
    wds.Calculate
    Msgbox("End")
 End Sub

 '---------------------------- 
 Private Sub wds_GetDistrParameters(ByVal sMsg As String, _
                                    ByVal InputInfo As SynthesisAPI.DistrParametersInput, _
                                    Cancel As Boolean)
   '<Add code here to handle the event.> 
    MsgBox (sMsg)
 End Sub

VB.NET

 'Specify a variable to handle the event. 
  Private WithEvents wds As WeibullDataSet

 '---------------------------- 
 Private Sub Main()
   'Associate the event variable with an object. 
    wds = New WeibullDataSet

   'Set the application to use your event procedure. 
    wds.UseEvents = True

   'To trigger the event, call the Calculate method without defining a data set.  
    wds.Calculate
    Msgbox("End")
 End Sub

 '---------------------------- 
 Private Sub wds_GetDistrParameters(sMsg As String, _
                                    InputInfo As DistrParametersInput, _
                                    ByRef Cancel As Boolean) Handles wds.GetDistrParameters
    '<Add code here to handle the event.> 
    MsgBox (sMsg)
 End Sub

@@ Line 1: / Line 1: @@
-{{Template:APIClass|WeibullEvents Class|WeibullEvents}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
-Displays a prompt for customized parameters.
-== Method Syntax ==
+<onlyinclude>Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.</onlyinclude>
-{{APIName|'''GetDistrParameters'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|sender}}
-{{APIPrefix|As}}
-{{APIName|[[WeibullDataSet Class|WeibullDataSet]],}}
-{{APIPrefix|ByVal}}
-{{APIName|sMsg}}
-{{APIPrefix|As String}}
-{{APIName|,}}
-{{APIPrefix|ByVal}}
-{{APIName|GetOnlyOneParameter}}
-{{APIPrefix|As Boolean}}
-{{APIName|,}}
-{{APIPrefix|ByVal}}
-{{APIName|Params}}
-{{APIPrefix|As}}
-{{APIName|List(}}
-{{APIPrefix|Of}}
-{{APIName|[[ParamInputInfo Class|ParamInputInfo]]),}}
-{{APIPrefix|ByRef}}
-{{APIName|Cancel}}
-{{APIPrefix|As Boolean}}
-{{APIName|)}}<br>
-{{APIComment|Called by ‘sender’ when additional input is required.}}
-== Parameters ==
-'''sender'''
-An WeibullDataSet object
-'''sMsg'''
+{{Template:API_EventsNote}}
-The main display label.
-'''GetOnlyOneParameter'''
+== Syntax ==
-Prompt for only one parameter
+ '''_GetDistrParameters'''(''sMsg'', ''InputInfo'', {{APIPrefix|ByRef}} ''Cancel'')
-'''Params'''
+===Parameters===
-A list of Parameter input information classes, ParamInputInfo, that would be updated by this prompt.
+''sMsg''
-{{APIComment|After processing with [[WeibullEvents.GetDistrParameters|GetDistrParameters]], the '''Value''' of each parameter will be updated.}}
+: Required. String. The message to display.
+''InputInfo''
+: Required. An array of [[DistrParametersInput Class|DistrParametersInput()]] type objects that represent the model's parameters.
+''Cancel''
+: Required. Boolean. Indicates whether the input was cancelled. Default value = False.
-'''Cancel'''
-If the prompt was closed by any means other than clicking the "Okay", this value would be set to True.
-== Usage Example ==
+== Example ==
+The following example provides a simple demonstration on how to customize the event procedure.
+ '''VBA'''
+ {{APIComment|'Specify a variable to handle the event.}}
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
+     {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
+   {{APIComment|'Set the application to use your event procedure.}}
+     wds.UseEvents = True
+   {{APIComment|'To trigger the event, call the Calculate method without defining a data set. }}
+     wds.Calculate
+     Msgbox({{APIString|"End"}})
+  {{APIPrefix|End Sub}}
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} wds_GetDistrParameters({{APIPrefix|ByVal}} sMsg {{APIPrefix|As String}}, _
+                                     {{APIPrefix|ByVal}} InputInfo {{APIPrefix|As SynthesisAPI.DistrParametersInput}}, _
+                                     Cancel {{APIPrefix|As Boolean}})
+   {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (sMsg)
+  {{APIPrefix|End Sub}}
-{{APIComment|Declare a New class that Inherits from WeibullEvents.}}<br>
+ '''VB.NET'''
-{{APIComment|Override the method.}}<br>
-        Private Class myEvents
+ {{APIComment|'Specify a variable to handle the event.}}
-            Inherits WeibullEvents
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
-            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)
+ {{APIComment|'----------------------------}}
-                MessageBox.Show("Additional overridden code here.")
+  {{APIPrefix|Private Sub}} Main()
-                End Sub
+   {{APIComment|'Associate the event variable with an object.}}
-        End Class
+     wds = {{APIPrefix|New}} WeibullDataSet
-{{APIComment|Declare the WeibullDataSet.}}<br>
+   {{APIComment|'Set the application to use your event procedure.}}
-        Dim WDS as New WeibullDataSet
+     wds.UseEvents = True
-{{APIComment|Use the created myEvents class in place of the one created by the dataset.}}<br>
+   {{APIComment|'To trigger the event, call the Calculate method without defining a data set. }}
-        WDS.Events = New myEvents
+     wds.Calculate
+     Msgbox({{APIString|"End"}})
-{{APIComment|Creates a new list of ParamInputInfo.  Populate the list.}}
+  {{APIPrefix|End Sub}}
-        Dim Params As New List(Of ParamInputInfo)
-        Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))
+ {{APIComment|'----------------------------}}
-        Params.Add(New ParamInputInfo("Param2", 0, Double.MaxValue, False, True))
+  {{APIPrefix|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix|As String}}, _
+                                     InputInfo {{APIPrefix|As DistrParametersInput}}, _
-{{APIComment|Create a Boolean for return of "Cancel" parameter.}}
+                                     {{APIPrefix|ByRef}} Cancel {{APIPrefix|As Boolean}}) {{APIPrefix|Handles}} wds.GetDistrParameters
-        Dim wasCanceled As Boolean
+    {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (sMsg)
-{{APIComment|Prompt user to input the parameters.}}
+  {{APIPrefix|End Sub}}
-        WEvents.GetDistrParameters(WDS, "Message1", True, Params, wasCanceled)
-{{APIComment|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

WeibullDataSet.GetDistrParameters: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search