ALTADataSet.UpdateCalculationProgress: Difference between revisions

Latest revision as of 23:43, 6 September 2016

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 ads As ALTADataSet

 '---------------------------- 
 Sub Main()
   'Associate the event variable with an object. 
    Set ads = New ALTADataSet

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

   'Define a stress type with a use stress level of 300. 
    Call ads.AddStressDefinition("Stress1", , 300)  

   'To trigger the event, analyze a data set. 
    Call ads.AddFailure_2(245, 1, 353)
    Call ads.AddFailure_2(110, 1, 373)
    Call ads.AddFailure_2(180, 1, 373)  
    Call ads.AddFailure_2(50, 1, 393)
    Call ads.AddFailure_2(70, 1, 393)

    ads.Calculate
    Msgbox("End")

 End Sub

 '---------------------------- 
 Private Sub ads_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 ads As ALTADataSet

 '---------------------------- 
 Sub Main()
   'Associate the event variable with an object. 
    ads = New ALTADataSet

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

   'Define a stress type with a use stress level of 300. 
    ads.AddStressDefinition("Stress1", , 300)  

   'To trigger the event, analyze a data set. 
    ads.AddFailure(245, 1, 353)
    ads.AddFailure(110, 1, 373)
    ads.AddFailure(180, 1, 373)  
    ads.AddFailure(50, 1, 393)
    ads.AddFailure(70, 1, 393)

    ads.Calculate
    Msgbox("End")

 End Sub

 '---------------------------- 
 Private Sub ads_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 ads.UpdateCalculationProgress
   '<Add code here to handle the event.> 
    MsgBox (msgx_0)
 End Sub

@@ Line 1: / Line 1: @@
-{{Template:APIClass|ALTAEvents Class|ALTAEvents}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[ALTADataSet Class|ALTADataSet]]}}
-Provides ability to customize the calculation progress display.
-== Method Syntax ==
+<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|[[ALTADataSet Class|ALTADataSet]]}}{{APIPrefix|, ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIPrefix|, ByVal}}{{APIName|msgx_1}}{{APIPrefix|As String}}{{APIPrefix|, ByVal}}{{APIName|pdone}}{{APIPrefix|As Double}}{{APIPrefix|, ByVal}}{{APIName|append_to}}{{APIPrefix|As Boolean}}{{APIPrefix|, ByVal}}{{APIName|Prev_increment}}{{APIPrefix|As Long}}{{APIPrefix|, ByRef}}{{APIName|Cancel}}{{APIPrefix|As Boolean}}{{APIName|)}}<br>
-{{APIComment|Called by ‘sender’ when the calculation progress should be updated.}}
-== Parameters ==
-'''sender'''
-An ALTADataSet object
-'''msgx_0'''
+{{Template:API_EventsNote}}
-The main display label.
-'''msgx_1'''
+== Syntax ==
-The remaining label.
+ '''_UpdateCalculationProgress'''(''msgx_0'', ''msgx_1'', ''pdone'', ''append_to'', ''Prev_increment'', {{APIPrefix|ByRef}} ''Cancel'')
-'''pdone '''
+===Parameters===
-The percentage,in decimal, to display. (0 to .99)
+''msgx_0''
+: Required. String. The message to display.
-'''append_to'''
+''msgx_1''
-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.
+: Required. String. Additional message to display.
-'''Prev_increment'''
+''pdone''
-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.
+: Required. Double. The percentage done, in decimal form (0.00 to 0.99).
-'''Cancel'''
+''append_to''
-This determines if the calculation can be cancelled.
+: Required. Boolean. Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.
-== Usage Example ==
+''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.
-{{APIComment|Declare the ALTAEvents.}}<br>
+''Cancel''
-{{APIComment|Declare the ALTADataSet.}}<br>
+: Required. Boolean. Indicates whether the calculation process has been cancelled.
-{{APIComment|Note: The ALTADataSet constructor already creates a new ALTAEvents, which could be used in place of AEvents in the example below.}}
-        Dim AEvents as New ALTAEvents
-        Dim ADS as New ALTADataSet
-{{APIComment|Update the calculation progress display.}}
-        AEvents.UpdateCalculationProgress(ADS, "NewMessage1", "NewMessage2", 100, False, 0, True)
+== 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}} ads {{APIPrefix|As}} ALTADataSet
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
+     {{APIPrefix|Set}} ads = {{APIPrefix|New}} ALTADataSet
+   {{APIComment|'Set the application to use your event procedure.}}
+     ads.UseEvents = True
+   {{APIComment|'Define a stress type with a use stress level of 300.}}
+     {{APIPrefix|Call}} ads.AddStressDefinition({{APIString|"Stress1"}}, , 300)
+   {{APIComment|'To trigger the event, analyze a data set.}}
+     {{APIPrefix|Call}} ads.AddFailure_2(245, 1, 353)
+     {{APIPrefix|Call}} ads.AddFailure_2(110, 1, 373)
+     {{APIPrefix|Call}} ads.AddFailure_2(180, 1, 373)
+     {{APIPrefix|Call}} ads.AddFailure_2(50, 1, 393)
+     {{APIPrefix|Call}} ads.AddFailure_2(70, 1, 393)
+     ads.Calculate
+     Msgbox({{APIString|"End"}})
+  {{APIPrefix|End Sub}}
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} ads_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}}
+ '''VB.NET'''
+ {{APIComment|'Specify a variable to handle the event.}}
+   {{APIPrefix|Private WithEvents}} ads {{APIPrefix|As}} ALTADataSet
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Sub}} Main()
+   {{APIComment|'Associate the event variable with an object.}}
+     ads = {{APIPrefix|New}} ALTADataSet
+   {{APIComment|'Set the application to use your event procedure.}}
+     ads.UseEvents = True
+   {{APIComment|'Define a stress type with a use stress level of 300.}}
+     ads.AddStressDefinition({{APIString|"Stress1"}}, , 300)
+   {{APIComment|'To trigger the event, analyze a data set.}}
+     ads.AddFailure(245, 1, 353)
+     ads.AddFailure(110, 1, 373)
+     ads.AddFailure(180, 1, 373)
+     ads.AddFailure(50, 1, 393)
+     ads.AddFailure(70, 1, 393)
+     ads.Calculate
+     Msgbox({{APIString|"End"}})
+  {{APIPrefix|End Sub}}
+ {{APIComment|'----------------------------}}
+  {{APIPrefix|Private Sub}} ads_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}} ads.UpdateCalculationProgress
+   {{APIComment|'<Add code here to handle the event.>}}
+     MsgBox (msgx_0)
+  {{APIPrefix|End Sub}}

ALTADataSet.UpdateCalculationProgress: Difference between revisions

Latest revision as of 23:43, 6 September 2016

Syntax

Parameters

Example

Navigation menu

Search