WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 32: Line 32:
:''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.
:''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.
:''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.
:''Cancel'': This determines if the calculation can be cancelled.

Revision as of 22:43, 24 February 2014


Called when the calculation progress should be updated. Provides ability to customize the calculation progress display.

Method Syntax

  • UpdateCalculationProgress( sender As WeibullDataSet , msgx_0 As String, msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long, Cancel As Boolean )

Parameters

sender: A WeibullDataSet object.
msgx_0: The main display label.
msgx_1: The remaining label.
pdone : The percentage to display, in decimal form (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.

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