ALTADataSet.ShowCalculationProgress - Revision history

Kate Racaza at 23:43, 6 September 2016

2016-09-06T23:43:40Z

← Older revision		Revision as of 23:43, 6 September 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}
	~~{{Template:InProgress}}~~

Kate Racaza at 17:17, 17 August 2016

2016-08-17T17:17:41Z

← Older revision		Revision as of 17:17, 17 August 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[~~ALTAEvents~~ Class\|~~ALTAEvents~~]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}
	{{Template:InProgress}}		{{Template:InProgress}}


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


			{{Template:API_EventsNote}}

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


			== Example ==
			The following example provides a simple demonstration on how to customize the event procedure.
			'''VBA'''

			{{APIComment\|'Specify a variable to handle the event.}}
			{{APIPrefix\|Private WithEvents}} ads {{APIPrefix\|As}} ALTADataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Sub}} Main()
			{{APIComment\|'Associate the event variable with an object.}}
			{{APIPrefix\|Set}} ads = {{APIPrefix\|New}} ALTADataSet

			{{APIComment\|'Set the application to use your event procedure.}}
			ads.UseEvents = True

			{{APIComment\|'Define a stress type with a use stress level of 300.}}
			{{APIPrefix\|Call}} ads.AddStressDefinition({{APIString\|"Stress1"}}, , 300)

			{{APIComment\|'To trigger the event, analyze a data set.}}
			{{APIPrefix\|Call}} ads.AddFailure_2(245, 1, 353)
			{{APIPrefix\|Call}} ads.AddFailure_2(110, 1, 373)
			{{APIPrefix\|Call}} ads.AddFailure_2(180, 1, 373)
			{{APIPrefix\|Call}} ads.AddFailure_2(50, 1, 393)
			{{APIPrefix\|Call}} ads.AddFailure_2(70, 1, 393)

			ads.Calculate
			Msgbox({{APIString\|"End"}})

			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} ads_ShowCalculationProgress()
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox ("ShowCalculationProgress event")
			{{APIPrefix\|End Sub}}

			'''VB.NET'''

			{{APIComment\|'Specify a variable to handle the event.}}
			{{APIPrefix\|Private WithEvents}} ads {{APIPrefix\|As}} ALTADataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Sub}} Main()
			{{APIComment\|'Associate the event variable with an object.}}
			ads = {{APIPrefix\|New}} ALTADataSet

			{{APIComment\|'Set the application to use your event procedure.}}
			ads.UseEvents = True

			{{APIComment\|'Define a stress type with a use stress level of 300.}}
			ads.AddStressDefinition({{APIString\|"Stress1"}}, , 300)

			{{APIComment\|'To trigger the event, analyze a data set.}}
			ads.AddFailure(245, 1, 353)
			ads.AddFailure(110, 1, 373)
			ads.AddFailure(180, 1, 373)
			ads.AddFailure(50, 1, 393)
			ads.AddFailure(70, 1, 393)

			ads.Calculate
			Msgbox({{APIString\|"End"}})

			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} ads_ShowCalculationProgress() {{APIPrefix\|Handles}} ads.ShowCalculationProgress
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox ("ShowCalculationProgress event")
			{{APIPrefix\|End Sub}}

Kate Racaza: moved ALTAEvents.ShowCalculationProgress to ALTADataSet.ShowCalculationProgress: Change in API structure

2016-08-17T17:11:43Z

moved ALTAEvents.ShowCalculationProgress to ALTADataSet.ShowCalculationProgress: Change in API structure

← Older revision	Revision as of 17:11, 17 August 2016
(No difference)

Kate Racaza at 16:05, 6 May 2016

2016-05-06T16:05:17Z

← Older revision		Revision as of 16:05, 6 May 2016
Line 1:		Line 1:
	{{Template:~~APIClass\|ALTAEvents Class\|ALTAEvents~~}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTAEvents Class\|ALTAEvents]]}}
	{{Template:~~WeibullEvents~~.~~ShowCalculationProgress.Cmt}}~~		{{Template:InProgress}}

	~~== Syntax ==~~
	~~<ul><li>~~
	~~ShowCalculationProgress(~~
	~~{{APIName\|sender}}~~
	~~{{APIPrefix\|As}}~~
	~~{{APIName\|~~[[~~ALTADataSet~~ Class\|~~ALTADataSet~~]]}})
	~~</li></ul>~~

	~~Parameters~~
	~~:''sender'': An [[ALTADataSet Class\|ALTADataSet]] object.~~

	~~== Usage Example ==~~
	~~This example demonstrates how to show the calculation progress display.~~
	{{~~APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents, and set the dataset's events.~~}}
	~~Private Class myEvents~~
	~~Inherits WeibullEvents~~
	~~Public Overrides Sub ShowCalculationProgress(sender As ALTADataSet)~~
	~~MyBase.ShowCalculationProgress(sender)~~
	~~{{APIComment\|'<Additional overridden code here.>}}~~
	~~End Sub~~
	~~End Class~~

	~~{{APIComment\|'Set the new Events class.}}~~
	~~ADS.Events = New myEvents~~

	~~{{APIComment\|'Show calculation progress.}}~~
	~~ADS.Events.ShowCalculationProgress(ADS)~~

Chris Kahn: /* Usage Example */

2014-05-06T16:45:49Z

Usage Example

← Older revision		Revision as of 16:45, 6 May 2014
Line 15:		Line 15:
	== Usage Example ==		== Usage Example ==
	This example demonstrates how to show the calculation progress display.		This example demonstrates how to show the calculation progress display.
	{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}		{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents, and set the dataset's events.}}
	~~{{APIComment\|'~~and set the dataset's events.}}
	Private Class myEvents		Private Class myEvents
	Inherits WeibullEvents		Inherits WeibullEvents

Chris Kahn: /* Usage Example */

2014-05-05T22:19:23Z

Usage Example

← Older revision		Revision as of 22:19, 5 May 2014
Line 14:		Line 14:

	== Usage Example ==		== Usage Example ==
			This example demonstrates how to show the calculation progress display.
	{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}		{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}
	{{APIComment\|'and set the dataset's events.}}		{{APIComment\|'and set the dataset's events.}}

Chris Kahn: /* Usage Example */

2014-05-05T22:00:25Z

Usage Example

← Older revision		Revision as of 22:00, 5 May 2014
Line 16:		Line 16:

	{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}		{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}
	{{APIComment\|'and set the dataset's ~~Events~~.}}		{{APIComment\|'and set the dataset's events.}}
	Private Class myEvents		Private Class myEvents
	Inherits WeibullEvents		Inherits WeibullEvents

Chris Kahn: /* Usage Example */

2014-05-05T22:00:06Z

Usage Example

← Older revision		Revision as of 22:00, 5 May 2014
Line 21:		Line 21:
	Public Overrides Sub ShowCalculationProgress(sender As ALTADataSet)		Public Overrides Sub ShowCalculationProgress(sender As ALTADataSet)
	MyBase.ShowCalculationProgress(sender)		MyBase.ShowCalculationProgress(sender)
	("Additional overridden code here.")		{{APIComment\|'<Additional overridden code here.>}}
	End Sub		End Sub
	End Class		End Class

Chris Kahn: /* Usage Example */

2014-05-05T21:59:41Z

Usage Example

← Older revision		Revision as of 21:59, 5 May 2014
Line 15:		Line 15:
	== Usage Example ==		== Usage Example ==

	{{APIComment\|~~Declare the ALTAEvents~~.}}~~<br>~~		{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}
	{{APIComment\|~~Declare~~ the ~~ALTADataSet~~.}}~~<br>~~		{{APIComment\|'and set the dataset's Events.}}
	{{APIComment\|~~Note: The ALTADataSet constructor already creates a~~ new ~~ALTAEvents, which could be used in place of AEvents in the example below~~.}}~~<br>~~		Private Class myEvents
	~~Dim AEvents as New ALTAEvents~~		Inherits WeibullEvents
	~~Dim~~ ADS as New ~~ALTADataSet~~		Public Overrides Sub ShowCalculationProgress(sender As ALTADataSet)
			MyBase.ShowCalculationProgress(sender)
	{{APIComment\|Show ~~the current Calculation Progress~~.}}		("Additional overridden code here.")
	~~AEvents~~.ShowCalculationProgress(ADS)		End Sub
			End Class

			{{APIComment\|'Set the new Events class.}}
			ADS.Events = New myEvents

			{{APIComment\|'Show calculation progress.}}
			ADS.Events.ShowCalculationProgress(ADS)

Chris Kahn at 21:12, 26 February 2014

2014-02-26T21:12:44Z

← Older revision		Revision as of 21:12, 26 February 2014
Line 11:		Line 11:

	Parameters		Parameters
	:''sender'': A [[ALTADataSet Class\|ALTADataSet]] object.		:''sender'': An [[ALTADataSet Class\|ALTADataSet]] object.

	== Usage Example ==		== Usage Example ==

← Older revision		Revision as of 17:17, 17 August 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|.[[~~ALTAEvents~~ Class\|~~ALTAEvents~~]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet Class\|ALTADataSet]]}}
	{{Template:InProgress}}		{{Template:InProgress}}


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


			{{Template:API_EventsNote}}

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


			== Example ==
			The following example provides a simple demonstration on how to customize the event procedure.
			'''VBA'''

			{{APIComment\|'Specify a variable to handle the event.}}
			{{APIPrefix\|Private WithEvents}} ads {{APIPrefix\|As}} ALTADataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Sub}} Main()
			{{APIComment\|'Associate the event variable with an object.}}
			{{APIPrefix\|Set}} ads = {{APIPrefix\|New}} ALTADataSet

			{{APIComment\|'Set the application to use your event procedure.}}
			ads.UseEvents = True

			{{APIComment\|'Define a stress type with a use stress level of 300.}}
			{{APIPrefix\|Call}} ads.AddStressDefinition({{APIString\|"Stress1"}}, , 300)

			{{APIComment\|'To trigger the event, analyze a data set.}}
			{{APIPrefix\|Call}} ads.AddFailure_2(245, 1, 353)
			{{APIPrefix\|Call}} ads.AddFailure_2(110, 1, 373)
			{{APIPrefix\|Call}} ads.AddFailure_2(180, 1, 373)
			{{APIPrefix\|Call}} ads.AddFailure_2(50, 1, 393)
			{{APIPrefix\|Call}} ads.AddFailure_2(70, 1, 393)

			ads.Calculate
			Msgbox({{APIString\|"End"}})

			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} ads_ShowCalculationProgress()
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox ("ShowCalculationProgress event")
			{{APIPrefix\|End Sub}}

			'''VB.NET'''

			{{APIComment\|'Specify a variable to handle the event.}}
			{{APIPrefix\|Private WithEvents}} ads {{APIPrefix\|As}} ALTADataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Sub}} Main()
			{{APIComment\|'Associate the event variable with an object.}}
			ads = {{APIPrefix\|New}} ALTADataSet

			{{APIComment\|'Set the application to use your event procedure.}}
			ads.UseEvents = True

			{{APIComment\|'Define a stress type with a use stress level of 300.}}
			ads.AddStressDefinition({{APIString\|"Stress1"}}, , 300)

			{{APIComment\|'To trigger the event, analyze a data set.}}
			ads.AddFailure(245, 1, 353)
			ads.AddFailure(110, 1, 373)
			ads.AddFailure(180, 1, 373)
			ads.AddFailure(50, 1, 393)
			ads.AddFailure(70, 1, 393)

			ads.Calculate
			Msgbox({{APIString\|"End"}})

			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} ads_ShowCalculationProgress() {{APIPrefix\|Handles}} ads.ShowCalculationProgress
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox ("ShowCalculationProgress event")
			{{APIPrefix\|End Sub}}