ALTADataSet.UpdateCalculationProgress

Member of: SynthesisAPI.ALTADataSet

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