WeibullDataSet.UpdateCalculationProgress: Difference between revisions

Latest revision as of 23:41, 6 September 2016

Member of: SynthesisAPI.WeibullDataSet

Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.

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

_UpdateCalculationProgress(msgx_0, msgx_1, pdone, append_to, Prev_increment, ByRef Cancel)

Parameters

msgx_0

Required. String. The message to display.

msgx_1

Required. String. Additional message to display.

pdone

Required. Double. The percentage done, in decimal form (0.00 to 0.99).

append_to

Required. Boolean. Indicates whether to append pdone in the progress display at the rate of Prev_increment; otherwise, pdone will replace the value.

Prev_increment

Required. Double. The value of the incremental value per progress update if append_to is True. If append_to is False, this value is ignored.

Cancel

Required. Boolean. Indicates whether the calculation process has been cancelled.

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

 '---------------------------- 
 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, analyze a data set. 
    Call wds.AddFailure(100, 1)
    Call wds.AddFailure(120, 1)
    Call wds.AddFailure(130, 1)  
    Call wds.AddFailure(160, 1) 
    Call wds.AddFailure(190, 1) 
    wds.Calculate
    Msgbox("End")
 End Sub

 '---------------------------- 
 Private Sub wds_UpdateCalculationProgress(ByVal msgx_0 As String, ByVal msgx_1 As String, _
                                           ByVal pdone As Double, ByVal append_to As Boolean, _
                                           ByVal Prev_increment As Double, Cancel As Boolean)
   '<Add code here to handle the event.> 
    MsgBox (msgx_0)
 End Sub

VB.NET

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

 '---------------------------- 
 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, analyze a data set. 
    wds.AddFailure(100, 1)
    wds.AddFailure(120, 1)
    wds.AddFailure(130, 1)  
    wds.AddFailure(160, 1) 
    wds.AddFailure(190, 1) 
    wds.Calculate
    Msgbox("End")
 End Sub

 '---------------------------- 
 Private Sub wds_UpdateCalculationProgress(msgx_0 As String, msgx_1 As String, _
                                           pdone As Double, append_to As Boolean, _
                                           Prev_increment As Double, ByRef Cancel As Boolean) _
                                           Handles wds.UpdateCalculationProgress
   '<Add code here to handle the event.> 
    MsgBox (msgx_0)
 End Sub

@@ Line 1: / Line 1: @@
-{{Template:AWEAPIClass}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
-Provides ability to customize the calculation progress display.
-== Weibull Declaration  ==
+<onlyinclude>Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.</onlyinclude>
-{{APIName|UpdateCalculationProgress(}}
-{{APIPrefix|ByVal}}
-{{APIName|sender}}
-{{APIPrefix|As}}
-{{APIName|[[WeibullDataSet Class|WeibullDataSet]],_}}
-::::::{{APIPrefix|ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIName|,_}}
+{{Template:API_EventsNote}}
-::::::{{APIPrefix|ByVal}}{{APIName|msgx_1}}{{APIPrefix|As String}}{{APIName|,_}}
-::::::{{APIPrefix|ByVal}}{{APIName|pdone}}{{APIPrefix|As Double}}{{APIName|,_}}
-::::::{{APIPrefix|ByVal}}{{APIName|append_to}}{{APIPrefix|As Boolean}}{{APIName|,_}}
-::::::{{APIPrefix|ByVal}}{{APIName|Prev_increment}}{{APIPrefix|As Long}}{{APIName|,_}}
-::::::{{APIPrefix|ByRef}}{{APIName|Cancel}}{{APIPrefix|As Boolean}}{{APIName|)}}
-{{APIComment|Called by ‘sender’ when the calculation progress should be updated.}}
+== Syntax ==
+ '''_UpdateCalculationProgress'''(''msgx_0'', ''msgx_1'', ''pdone'', ''append_to'', ''Prev_increment'', {{APIPrefix|ByRef}} ''Cancel'')
-== ALTA Declaration  ==
+===Parameters===
+''msgx_0''
+: Required. String. The message to display.
-{{APIName|UpdateCalculationProgress(}}
+''msgx_1''
-{{APIPrefix|ByVal}}
+: Required. String. Additional message to display.
-{{APIName|sender}}
-{{APIPrefix|As}}
-{{APIName|[[ALTADataSet Class|ALTADataSet]],_}}
-::::::{{APIPrefix|ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIName|,_}}
+''pdone''
-::::::{{APIPrefix|ByVal}}{{APIName|msgx_1}}{{APIPrefix|As String}}{{APIName|,_}}
+: Required. Double. The percentage done, in decimal form (0.00 to 0.99).
-::::::{{APIPrefix|ByVal}}{{APIName|pdone}}{{APIPrefix|As Double}}{{APIName|,_}}
-::::::{{APIPrefix|ByVal}}{{APIName|append_to}}{{APIPrefix|As Boolean}}{{APIName|,_}}
-::::::{{APIPrefix|ByVal}}{{APIName|Prev_increment}}{{APIPrefix|As Long}}{{APIName|,_}}
-::::::{{APIPrefix|ByRef}}{{APIName|Cancel}}{{APIPrefix|As Boolean}}{{APIName|)}}
-{{APIComment|Called by ‘sender’ when the calculation progress should be updated.}}
+''append_to''
+: Required. Boolean. Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.
-== Parameters ==
+''Prev_increment''
-'''sender'''
+: Required. Double. The value of the incremental value per progress update if ''append_to'' is True.  If ''append_to'' is False, this value is ignored.
-An WeibullDataSet object
-'''msgx_0'''
+''Cancel''
-The main display label.
+: Required. Boolean. Indicates whether the calculation process has been cancelled.
-'''msgx_1'''
-The remaining label.
-'''pdone '''
+== Example ==
-The percentage,in decimal, to display. (0 to .99)
+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|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, analyze a data set.}}
+     {{APIPrefix|Call}} wds.AddFailure(100, 1)
+     {{APIPrefix|Call}} wds.AddFailure(120, 1)
+     {{APIPrefix|Call}} wds.AddFailure(130, 1)
+     {{APIPrefix|Call}} wds.AddFailure(160, 1)
+     {{APIPrefix|Call}} wds.AddFailure(190, 1)
+     wds.Calculate
+     Msgbox({{APIString|"End"}})
+  {{APIPrefix|End Sub}}
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} wds_UpdateCalculationProgress({{APIPrefix|ByVal}} ''msgx_0'' {{APIPrefix|As String}}, {{APIPrefix|ByVal}} ''msgx_1'' {{APIPrefix|As String}}, _
+                                            {{APIPrefix|ByVal}} ''pdone'' {{APIPrefix|As Double}}, {{APIPrefix|ByVal}} ''append_to'' {{APIPrefix|As Boolean}}, _
+                                            {{APIPrefix|ByVal}} ''Prev_increment'' {{APIPrefix|As Double}}, ''Cancel'' {{APIPrefix|As Boolean}})
+   {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (msgx_0)
+  {{APIPrefix|End Sub}}
-'''append_to'''
+ '''VB.NET'''
-If True, append '''pdone''' to the current percentage value in the progress display at the rate of '''Prev_increment''', otherwise '''pdone''' will replace the value.
+ {{APIComment|'Specify a variable to handle the event.}}
-'''Prev_increment'''
+   {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
-This is the value of the incremental value per progress update, if '''append_to''' is True.  If '''append_to''' is False, this value is ignored.
+ {{APIComment|'----------------------------}}
-'''Cancel'''
+  {{APIPrefix|Sub}} Main()
-This determines if the calculation can be cancelled.
+   {{APIComment|'Associate the event variable with an object.}}
+     wds = {{APIPrefix|New}} WeibullDataSet
-== Usage Example ==
+   {{APIComment|'Set the application to use your event procedure.}}
-{{APIComment|Declare the WeibullEvents.  Substitute [[ALTAEvents Class|ALTAEvents]] for ALTA.}}<br>
+     wds.UseEvents = True
-{{APIComment|Declare the WeibullDataSet. Substitute [[ALTADataSet Class|ALTADataSet]] for ALTA.}}<br>
-{{APIComment|Note: The WeibullDataSet/ALTADataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}
+   {{APIComment|'To trigger the event, analyze a data set.}}
-        Dim WEvents as New WeibullEvents
+     wds.AddFailure(100, 1)
-        Dim WDS as New WeibullDataSet
+     wds.AddFailure(120, 1)
+     wds.AddFailure(130, 1)
-{{APIComment|Update the calculation progress display.}}
+     wds.AddFailure(160, 1)
-        WEvents.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)
+     wds.AddFailure(190, 1)
+     wds.Calculate
+     Msgbox({{APIString|"End"}})
+  {{APIPrefix|End Sub}}
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} wds_UpdateCalculationProgress(''msgx_0'' {{APIPrefix|As String}}, ''msgx_1'' {{APIPrefix|As String}}, _
+                                            ''pdone'' {{APIPrefix|As Double}}, ''append_to'' {{APIPrefix|As Boolean}}, _
+                                            ''Prev_increment'' {{APIPrefix|As Double}}, {{APIPrefix|ByRef}} ''Cancel'' {{APIPrefix|As Boolean}}) _
+                                            {{APIPrefix|Handles}} wds.UpdateCalculationProgress
+   {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (msgx_0)
+  {{APIPrefix|End Sub}}

WeibullDataSet.UpdateCalculationProgress: Difference between revisions

Latest revision as of 23:41, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search