WeibullDataSet.ShowCalculationProgress: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:AWEAPIClass}}
{{Template:API}}{{Template:APIBreadcrumb|.[[WeibullDataSet Class|WeibullDataSet]]}}


Shows the current calculation progress if the calculation process is running.


== Weibull Declaration  ==
<onlyinclude>Occurs when the calculation process is running. Displays a progress bar.</onlyinclude>


{{APIPrefix|Public Overridable Sub}}
{{APIName|ShowCalculationProgress(}}
{{APIPrefix|ByVal}}
{{APIName|sender}}
{{APIPrefix|As}}
{{APIName|[[WeibullDataSet Class|WeibullDataSet]])}}


{{APIComment|Called by ‘sender’ when calculation progress should be shown.}}
{{Template:API_EventsNote}}


== Syntax ==
'''_ShowCalculationProgress'''()


== ALTA Declaration  ==


{{APIPrefix|Public Overridable Sub}}
== Example ==
{{APIName|ShowCalculationProgress(}}
The following example provides a simple demonstration on how to customize the event procedure.
{{APIPrefix|ByVal}}
'''VBA'''
{{APIName|sender}}
{{APIPrefix|As}}
{{APIComment|'Specify a variable to handle the event.}}
{{APIName|[[ALTADataSet Class|ALTADataSet]])}}
  {{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_ShowCalculationProgress()
  {{APIComment|'<Add code here to handle the event.>}}
    MsgBox ("ShowCalculationProgress event")
  {{APIPrefix|End Sub}}


{{APIComment|Called by ‘sender’ when calculation progress should be shown.}}
'''VB.NET'''
 
== Usage Example ==
{{APIComment|'Specify a variable to handle the event.}}
 
  {{APIPrefix|Private WithEvents}} wds {{APIPrefix|As}} WeibullDataSet
{{APIComment|Declare the WeibullEvents. Substitute [[ALTAEvents Class|ALTAEvents]] for ALTA.}}<br>
{{APIComment|Declare the WeibullDataSet. Substitute [[ALTADataSet Class|ALTADataSet]] for ALTA.}}<br>
{{APIComment|'----------------------------}}
{{APIComment|Note: The WeibullDataSet/ALTADataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.}}<br>
  {{APIPrefix|Sub}} Main()
        Dim WEvents as New WeibullEvents
  {{APIComment|'Associate the event variable with an object.}}
        Dim WDS as New WeibullDataSet
    wds = {{APIPrefix|New}} WeibullDataSet
 
{{APIComment|Show the current Calculation Progress.}}
  {{APIComment|'Set the application to use your event procedure.}}
        WEvents.ShowCalculationProgress(WDS)
    wds.UseEvents = True
  {{APIComment|'To trigger the event, calculate 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_ShowCalculationProgress() {{APIPrefix|Handles}} wds.ShowCalculationProgress
  {{APIComment|'<Add code here to handle the event.>}}
    MsgBox ("ShowCalculationProgress event")
  {{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 a progress bar.


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

_ShowCalculationProgress()


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_ShowCalculationProgress()
   '<Add code here to handle the event.> 
    MsgBox ("ShowCalculationProgress event")
 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, calculate 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_ShowCalculationProgress() Handles wds.ShowCalculationProgress
   '<Add code here to handle the event.> 
    MsgBox ("ShowCalculationProgress event")
 End Sub