WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:


== Syntax ==
== Syntax ==
  '''_UpdateCalculationProgress'''({{APIPrefix|ByVal}} ''msgx_0'' {{APIPrefix|As String}}, {{APIPrefix|ByVal}} ''msgx_1'' {{APIPrefix|As String}}, _
  '''_UpdateCalculationProgress'''({{APIPrefix|ByVal}} ''msgx_0'', {{APIPrefix|ByVal}} ''msgx_1'', {{APIPrefix|ByVal}} ''pdone'', _
                            {{APIPrefix|ByVal}} ''pdone'' {{APIPrefix|As Double}}, {{APIPrefix|ByVal}} ''append_to'' {{APIPrefix|As Boolean}}, _
                            {{APIPrefix|ByVal}} ''append_to'', {{APIPrefix|ByVal}} ''Prev_increment'', {{APIPrefix|ByRef}} ''Cancel'')
                            {{APIPrefix|ByVal}} ''Prev_increment'' {{APIPrefix|As Double}}, {{APIPrefix|ByRef}} ''Cancel'' {{APIPrefix|As Boolean}})


===Parameters===
===Parameters===
''msgx_0''
''msgx_0''
: The message to display.
: Required. String. The message to display.


''msgx_1''
''msgx_1''
: Additional message to display.
: Required. String. Additional message to display.


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


''append_to''
''append_to''
: Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.
: 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''
''Prev_increment''
: 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 value of the incremental value per progress update if ''append_to'' is True.  If ''append_to'' is False, this value is ignored.


''Cancel''
''Cancel''
: Indicates whether the calculation process has been cancelled.
: Required. Boolean. Indicates whether the calculation process has been cancelled.




== Example ==
== Example ==
The following example provides a simple demonstration on how to handle the event.
The following example provides a simple demonstration on how to customize the event procedure.
  '''VBA'''
  '''VBA'''
   
   
Line 45: Line 44:
     {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
     {{APIPrefix|Set}} wds = {{APIPrefix|New}} WeibullDataSet
   
   
   {{APIComment|'Set the application to use events.}}
   {{APIComment|'Set the application to use your event procedure.}}
     wds.UseEvents = True
     wds.UseEvents = True
   
   
   {{APIComment|'To raise the event, calculate a data set.}}
   {{APIComment|'To trigger the event, analyze a data set.}}
     {{APIPrefix|Call}} wds.AddFailure(100, 1)
     {{APIPrefix|Call}} wds.AddFailure(100, 1)
     {{APIPrefix|Call}} wds.AddFailure(120, 1)
     {{APIPrefix|Call}} wds.AddFailure(120, 1)
Line 76: Line 75:
     wds = {{APIPrefix|New}} WeibullDataSet
     wds = {{APIPrefix|New}} WeibullDataSet
   
   
   {{APIComment|'Set the application to use events.}}
   {{APIComment|'Set the application to use your event procedure.}}
     wds.UseEvents = True
     wds.UseEvents = True
   
   
   {{APIComment|'To raise the event, calculate a data set.}}
   {{APIComment|'To trigger the event, analyze a data set.}}
     wds.AddFailure(100, 1)
     wds.AddFailure(100, 1)
     wds.AddFailure(120, 1)
     wds.AddFailure(120, 1)

Revision as of 20:25, 16 August 2016

APIWiki.png


Member of: SynthesisAPI.WeibullDataSet Template:InProgress


Occurs when the calculation progress should be updated.


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(ByVal msgx_0, ByVal msgx_1, ByVal pdone, _
                           ByVal append_to, ByVal 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, ByRef 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