WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
{{Template:InProgress}}
{{Template:InProgress}}
<onlyinclude>Occurs when the calculation progress should be updated.</onlyinclude> 
{{Template:API_EventsNote}}
== Syntax ==
'''_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}}, {{APIPrefix|ByRef}} ''Cancel'' {{APIPrefix|As Boolean}})
===Parameters===
''msgx_0''
: The message to display.
''msgx_1''
: Additional message to display.
''pdone''
: The percentage done, in decimal form (0.00 to 0.99).
''append_to''
: Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.
''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.
''Cancel''
: Indicates whether the calculation process has been cancelled.
== Example ==
The following example provides a simple demonstration on how to handle the event.
'''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 events.}}
    wds.UseEvents = True
  {{APIComment|'To raise the event, calculate 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}}, {{APIPrefix|ByRef}} ''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}} wds {{APIPrefix|As}} WeibullDataSet
{{APIComment|'----------------------------}}
  {{APIPrefix|Sub}} Main()
  {{APIComment|'Associate the event variable with an object.}}
    wds = {{APIPrefix|New}} WeibullDataSet
  {{APIComment|'Set the application to use events.}}
    wds.UseEvents = True
  {{APIComment|'To raise the event, calculate 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({{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}}

Revision as of 17:39, 12 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 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)

Parameters

msgx_0

The message to display.

msgx_1

Additional message to display.

pdone

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

append_to

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

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.

Cancel

Indicates whether the calculation process has been cancelled.


Example

The following example provides a simple demonstration on how to handle the event.

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 events. 
    wds.UseEvents = True

   'To raise the event, calculate 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 events. 
    wds.UseEvents = True

   'To raise the event, calculate 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