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]]}}
-Displays a prompt for customized parameters.
-== Weibull Declaration  ==
+<onlyinclude>Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.</onlyinclude>
-{{APIPrefix|Public Overridable Sub}}
-{{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}}
+== Syntax ==
+ '''_GetDistrParameters'''(''sMsg'', ''InputInfo'', {{APIPrefix|ByRef}} ''Cancel'')
-== ALTA Declaration  ==
+===Parameters===
-{{APIPrefix|Public Overridable Sub}}
+''sMsg''
-{{APIName|GetDistrParameters(}}
+: Required. String. The message to display.
-{{APIPrefix|ByVal}}
+''InputInfo''
-{{APIName|sender}}
+: Required. An array of [[DistrParametersInput Class|DistrParametersInput()]] type objects that represent the model's parameters.
-{{APIPrefix|As}}
+''Cancel''
-{{APIName|ALTADataSet,}}
+: Required. Boolean. Indicates whether the input was cancelled. Default value = False.
-{{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 ==
+== Example ==
-'''sender'''
+The following example provides a simple demonstration on how to customize the event procedure.
-An WeibullDataSet object
+ '''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}}
-'''sMsg'''
+ '''VB.NET'''
-The main display label.
+ {{APIComment|'Specify a variable to handle the event.}}
-'''GetOnlyOneParameter'''
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
-Prompt for only one parameter
+ {{APIComment|'----------------------------}}
-'''Params'''
+  {{APIPrefix|Private Sub}} Main()
-A list of Parameter input information classes, ParamInputInfo, that would be updated by this prompt.
+   {{APIComment|'Associate the event variable with an object.}}
-          '''ParamInputInfo Class
+     wds = {{APIPrefix|New}} WeibullDataSet
-               Public Name As String
-               Public Min As Double
+   {{APIComment|'Set the application to use your event procedure.}}
-               Public Max As Double
+     wds.UseEvents = True
-               Public CanEqualMin As Boolean
-               Public CanEqualMax As Boolean
+   {{APIComment|'To trigger the event, call the Calculate method without defining a data set. }}
-               Public Value As Double
+     wds.Calculate
-          '''ParamInputInfo Declaration
+     Msgbox({{APIString|"End"}})
-               New(ByVal Name As String, ByVal Min As Double, ByVal Max As Double, ByVal CanEqualMin As Boolean, ByVal CanEqualMax As Boolean)
+  {{APIPrefix|End Sub}}
-          '''ParamInputInfo Usage
-              {{APIComment|After processing with [[GetDistrParameters]], the '''Value''' of each parameter will be updated.}}
+ {{APIComment|'----------------------------}}
-'''Cancel'''
+  {{APIPrefix|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix|As String}}, _
-If the prompt was closed by any means other than clicking the "Okay", this value would be set to True.
+                                     InputInfo {{APIPrefix|As DistrParametersInput}}, _
+                                     {{APIPrefix|ByRef}} Cancel {{APIPrefix|As Boolean}}) {{APIPrefix|Handles}} wds.GetDistrParameters
-== Usage Example ==
+    {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (sMsg)
-{{APIComment|Declare the WeibullEvents.  Substitute [[ALTAEvents Class|ALTAEvents]] for ALTA.}}<br>
+  {{APIPrefix|End Sub}}
-{{APIComment|Declare the WeibullDataSet. Substitute [[ALTADataSet Class|ALTADataSet]] for ALTA.}}<br>
-{{APIComment|Note: The WeibullDataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}
-        Dim WEvents as New WeibullEvents
-        Dim WDS As New WeibullDataSet
-{{APIComment|Creates a new list of ParamInputInfo.  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))
-{{APIComment|Prompt user to input the parameters.}}
-        WEvents.GetDistrParameters(WDS, "Message1", True, Params, True)
-{{APIComment|The new Parameter values are in their respective ParamInputInfo.Value variables.}}
-        Dim NewParameter1value as Double = Params(0).Value
-        Dim NewParameter2value as Double = Params(1).Value

WeibullDataSet.GetDistrParameters: Difference between revisions

Latest revision as of 23:40, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search