WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|WeibullEvents Class|WeibullEvents}}
{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}
Called by [[WeibullDataSet Class|WeibullDataSet]] object when the calculation progress should be updated. Provides ability to customize the calculation progress display.


== Method Syntax ==
<ul><li>UpdateCalculationProgress(
{{APIName|sender}}
{{APIPrefix|As}}
{{APIName|[[WeibullDataSet Class|WeibullDataSet]]}},
{{APIName|msgx_0}}
{{APIPrefix|As String}},
{{APIName|msgx_1}}
{{APIPrefix|As String}},
{{APIName|pdone}}
{{APIPrefix|As Double}},
{{APIName|append_to}}
{{APIPrefix|As Boolean}},
{{APIName|Prev_increment}}
{{APIPrefix|As Long}},
{{APIName|Cancel}}
{{APIPrefix|As Boolean}}
{{APIName|)}}</li></ul>


Parameters
<onlyinclude>Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.</onlyinclude>  
:''sender'': A [[WeibullDataSet Class|WeibullDataSet]] object.


:''msgx_0'': The main display label.


:''msgx_1'': The remaining label.
{{Template:API_EventsNote}}


:''pdone '': The percentage to display, in decimal form (0.00 to 0.99).
== Syntax ==
'''_UpdateCalculationProgress'''(''msgx_0'', ''msgx_1'', ''pdone'', ''append_to'', ''Prev_increment'', {{APIPrefix|ByRef}} ''Cancel'')


:''append_to'': 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.
===Parameters===
''msgx_0''
: Required. String. The message to display.


:''Prev_increment'': 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.
''msgx_1''
: Required. String. Additional message to display.


:''Cancel'': This determines if the calculation can be cancelled.
''pdone''
: Required. Double. The percentage done, in decimal form (0.00 to 0.99).


== Usage Example ==
''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.


{{APIComment|Declare a New class that Inherits from WeibullEvents.}}<br>
''Prev_increment''
{{APIComment|Override the method.}}<br>
: 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.
        Private Class myEvents
            Inherits WeibullEvents
            Public Overrides Sub UpdateCalculationProgress(sender As WeibullDataSet, msgx_0 As String, msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long, ByRef Cancel As Boolean)
                MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to, Prev_increment, Cancel)
                MessageBox.Show("Additional overridden code here.")
            End Sub
        End Class


{{APIComment|Declare the WeibullDataSet.}}<br>
''Cancel''
        Dim WDS as New WeibullDataSet
: Required. Boolean. Indicates whether the calculation process has been cancelled.


{{APIComment|Use the created myEvents class in place of the one created by the dataset.}}<br>
        WDS.Events = New myEvents


{{APIComment|Update the calculation progress display.}}
== Example ==
        WDS.Events.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)
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}}
 
'''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 your event procedure.}}
    wds.UseEvents = True
  {{APIComment|'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({{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}}

Latest revision as of 23:41, 6 September 2016

APIWiki.png


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
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullDataSet.UpdateCalculationProgress&oldid=64672"