WeibullDataSet.UpdateCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:AWEAPIClass}}
{{Template:APIClass|WeibullEvents Class|WeibullEvents}}


Provides ability to customize the calculation progress display.
Provides ability to customize the calculation progress display.
Line 10: Line 10:
{{APIPrefix|As}}
{{APIPrefix|As}}
{{APIName|[[WeibullDataSet Class|WeibullDataSet]],_}}
{{APIName|[[WeibullDataSet Class|WeibullDataSet]],_}}
::::::{{APIPrefix|ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIName|,_}}
::::::{{APIPrefix|ByVal}}{{APIName|msgx_1}}{{APIPrefix|As String}}{{APIName|,_}}
::::::{{APIPrefix|ByVal}}{{APIName|pdone}}{{APIPrefix|As Double}}{{APIName|,_}}
::::::{{APIPrefix|ByVal}}{{APIName|append_to}}{{APIPrefix|As Boolean}}{{APIName|,_}}
::::::{{APIPrefix|ByVal}}{{APIName|Prev_increment}}{{APIPrefix|As Long}}{{APIName|,_}}
::::::{{APIPrefix|ByRef}}{{APIName|Cancel}}{{APIPrefix|As Boolean}}{{APIName|)}}
{{APIComment|Called by ‘sender’ when the calculation progress should be updated.}}
== ALTA Declaration  ==
{{APIName|UpdateCalculationProgress(}}
{{APIPrefix|ByVal}}
{{APIName|sender}}
{{APIPrefix|As}}
{{APIName|[[ALTADataSet Class|ALTADataSet]],_}}


::::::{{APIPrefix|ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIName|,_}}
::::::{{APIPrefix|ByVal}}{{APIName|msgx_0}}{{APIPrefix|As String}}{{APIName|,_}}
Line 61: Line 44:
== Usage Example ==
== Usage Example ==


{{APIComment|Declare the WeibullEvents.  Substitute [[ALTAEvents Class|ALTAEvents]] for ALTA.}}<br>
{{APIComment|Declare the WeibullEvents.}}<br>
{{APIComment|Declare the WeibullDataSet. Substitute [[ALTADataSet Class|ALTADataSet]] for ALTA.}}<br>
{{APIComment|Declare the WeibullDataSet.}}<br>
{{APIComment|Note: The WeibullDataSet/ALTADataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}
{{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 WEvents as New WeibullEvents
         Dim WDS as New WeibullDataSet
         Dim WDS as New WeibullDataSet

Revision as of 22:50, 16 September 2013
SynAPI.png
Main Page
WeibullEvents


Provides ability to customize the calculation progress display.

Weibull Declaration

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 to .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 the WeibullEvents.
Declare the WeibullDataSet.
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

Update the calculation progress display. 

       WEvents.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullDataSet.UpdateCalculationProgress&oldid=41751"