WeibullDataSet.UpdateCalculationProgress: Difference between revisions
John Leavitt (talk | contribs) No edit summary |
Albert Szeto (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:AWEAPIClass}} | {{Template:AWEAPIClass}} | ||
Provides ability to customize the calculation progress display. | |||
== Weibull Declaration == | == Weibull Declaration == | ||
| Line 34: | Line 36: | ||
{{APIComment|Called by ‘sender’ when the calculation progress should be updated.}} | {{APIComment|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 == | |||
{{APIComment|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details. Substitute [[ALTADataSet]] for ALTA.}} | |||
Dim WDS as New WeibullDataSet | |||
{{APIComment|Update the calculation progress display.}} | |||
WDS.Events.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True) | |||
Revision as of 22:35, 10 September 2013
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.
ALTA Declaration
UpdateCalculationProgress( ByVal sender As ALTADataSet,_
- 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 WeibullDataSet. See New WeibullDataSet for additional details. Substitute ALTADataSet for ALTA.
Dim WDS as New WeibullDataSet
Update the calculation progress display.
WDS.Events.UpdateCalculationProgress(WDS, "NewMessage1", "NewMessage2", 100, False, 0, True)