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:AWEAPIClass}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
-== Weibull Declaration  ==
-{{APIPrefix|Public Overridable Sub}}
+<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,(}}
-{{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),}}
-{{APIPrefix|ByRef}}
-{{APIName|Cancel}}
-{{APIPrefix|As Boolean}}
-{{APIName|)}}
-{{APIComment|Called by ‘sender’ when additional input is required.}}
+{{Template:API_EventsNote}}
-== ALTA Declaration  ==
+== Syntax ==
-{{APIPrefix|Public Overridable Sub}}
+ '''_GetDistrParameters'''(''sMsg'', ''InputInfo'', {{APIPrefix|ByRef}} ''Cancel'')
-{{APIName|GetDistrParameters(}}
-{{APIPrefix|ByVal}}
-{{APIName|sender}}
-{{APIPrefix|As}}
-{{APIName|ALTADataSet,(}}
-{{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),}}
-{{APIPrefix|ByRef}}
-{{APIName|Cancel}}
-{{APIPrefix|As Boolean}}
-{{APIName|)}}
-{{APIComment|Called by ‘sender’ when additional input is required.}}
+===Parameters===
+''sMsg''
+: 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.
+== 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}}
+ '''VB.NET'''
+ {{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.}}
+     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(sMsg {{APIPrefix|As String}}, _
+                                     InputInfo {{APIPrefix|As DistrParametersInput}}, _
+                                     {{APIPrefix|ByRef}} Cancel {{APIPrefix|As Boolean}}) {{APIPrefix|Handles}} wds.GetDistrParameters
+    {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (sMsg)
+  {{APIPrefix|End Sub}}

WeibullDataSet.GetDistrParameters: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search