WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 35: Line 35:
== Usage Example ==
== Usage Example ==


{{APIComment|Declare the WeibullEvents.}}<br>
{{APIComment|Declare a New class that Inherits from WeibullEvents.}}<br>
{{APIComment|Override the method.}}<br>
        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>
{{APIComment|Declare the WeibullDataSet.}}<br>
{{APIComment|Note: The WeibullDataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}
        Dim WEvents as New WeibullEvents
         Dim WDS as New WeibullDataSet
         Dim WDS as New WeibullDataSet
{{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.}}
{{APIComment|Update the calculation progress display.}}
         WEvents.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)
         WEvents.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)

Revision as of 21:46, 9 October 2013



Provides ability to customize the calculation progress display.

Method Syntax

UpdateCalculationProgress( ByVal sender As WeibullDataSet , ByVal msgx_0 As String, ByVal msgx_1 As String, ByVal pdone As Double, ByVal append_to As Boolean, ByVal Prev_increment As Long, ByRef Cancel As Boolean )
Called by ‘sender’ when the calculation progress should be updated.

Parameters

sender An WeibullDataSet object

msgx_0 The main display label.

msgx_1 The remaining label.

pdone The percentage, in decimal, to display. (0.00 to 0.99)

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.

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.

Cancel This determines if the calculation can be cancelled.

Usage Example

Declare a New class that Inherits from WeibullEvents.
Override the method.

       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

Declare the WeibullDataSet.

       Dim WDS as New WeibullDataSet

Use the created myEvents class in place of the one created by the dataset.

       WDS.Events = New myEvents

Update the calculation progress display.

       WEvents.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)