ALTADataSet.UpdateCalculationProgress - Revision history

Kate Racaza at 23:43, 6 September 2016

2016-09-06T23:43:42Z

← 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:10, 17 August 2016

2016-08-17T17:10:10Z

← Older revision		Revision as of 17:10, 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 messages regarding the progress of the calculations.</onlyinclude>


			{{Template:API_EventsNote}}

			== Syntax ==
			'''_UpdateCalculationProgress'''(''msgx_0'', ''msgx_1'', ''pdone'', ''append_to'', ''Prev_increment'', {{APIPrefix\|ByRef}} ''Cancel'')

			===Parameters===
			''msgx_0''
			: Required. String. The message to display.

			''msgx_1''
			: Required. String. Additional message to display.

			''pdone''
			: Required. Double. The percentage done, in decimal form (0.00 to 0.99).

			''append_to''
			: Required. Boolean. Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.

			''Prev_increment''
			: Required. Double. The value of the incremental value per progress update if ''append_to'' is True. If ''append_to'' is False, this value is ignored.

			''Cancel''
			: Required. Boolean. Indicates whether the calculation process has been cancelled.


			== 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_UpdateCalculationProgress({{APIPrefix\|ByVal}} ''msgx_0'' {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} ''msgx_1'' {{APIPrefix\|As String}}, _
			{{APIPrefix\|ByVal}} ''pdone'' {{APIPrefix\|As Double}}, {{APIPrefix\|ByVal}} ''append_to'' {{APIPrefix\|As Boolean}}, _
			{{APIPrefix\|ByVal}} ''Prev_increment'' {{APIPrefix\|As Double}}, ''Cancel'' {{APIPrefix\|As Boolean}})
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (msgx_0)
			{{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_UpdateCalculationProgress(''msgx_0'' {{APIPrefix\|As String}}, ''msgx_1'' {{APIPrefix\|As String}}, _
			''pdone'' {{APIPrefix\|As Double}}, ''append_to'' {{APIPrefix\|As Boolean}}, _
			''Prev_increment'' {{APIPrefix\|As Double}}, {{APIPrefix\|ByRef}} ''Cancel'' {{APIPrefix\|As Boolean}}) _
			{{APIPrefix\|Handles}} ads.UpdateCalculationProgress
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (msgx_0)
			{{APIPrefix\|End Sub}}

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

2016-08-17T16:44:27Z

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

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

Kate Racaza: Replaced content with '{{Template:API}}{{Template:APIBreadcrumb|.ALTAEvents}} {{Template:InProgress}}'

2016-05-06T16:03:27Z

Replaced content with '{{Template:API}}{{Template:APIBreadcrumb|.ALTAEvents}} {{Template:InProgress}}'

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

	~~== Syntax ==~~
	~~<ul><li>UpdateCalculationProgress(~~
	~~{{APIName\|sender}}~~
	~~{{APIPrefix\|As}}~~
	~~{{APIName\|~~[[~~ALTADataSet~~ Class\|~~ALTADataSet~~]]}},
	{{~~APIName\|msgx_0}}~~
	~~{{APIPrefix\|As String}},~~
	~~{{APIName\|msgx_1}}~~
	~~{{APIPrefix\|As String}},~~
	~~{{APIName\|pdone}}~~
	~~{{APIPrefix\|As Double}},~~
	~~{{APIName\|append_to}}~~
	~~{{APIPrefix\|As Boolean}},~~
	~~{{APIName\|Prev_increment}}~~
	~~{{APIPrefix\|As Long}},~~
	~~{{APIName\|Cancel}}~~
	~~{{APIPrefix\|As Boolean}}~~
	~~{{APIName\|)}}</li></ul>~~

	~~Parameters~~
	:~~''sender'': An [[ALTADataSet Class\|ALTADataSet]] 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 ==~~
	~~This example demonstrates how to produce a dialog box when the calculation progress should be updated.~~
	~~{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents, and set the dataset's events.}}~~
	~~Private Class myEvents~~
	~~Inherits WeibullEvents~~
	~~Public Overrides Sub UpdateCalculationProgress(sender As ALTADataSet, 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)~~
	~~{{APIComment\|'<Additional overridden code here.>}}~~
	~~End Sub~~
	~~End Class~~

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

	~~{{APIComment\|'Update calculation progress.}}~~
	~~ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)~~

	~~{{APIComment\|'The "Cancel" checkbox reflects the value of wasCanceled.~~}}

Chris Kahn: /* Usage Example */

2014-05-05T22:12:48Z

Usage Example

← Older revision		Revision as of 22:12, 5 May 2014
Line 56:		Line 56:
	ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)		ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)

	{{APIComment\|'The "Cancel" checkbox reflects the value of wasCanceled}}		{{APIComment\|'The "Cancel" checkbox reflects the value of wasCanceled.}}

Chris Kahn: /* Usage Example */

2014-05-05T22:12:33Z

Usage Example

← Older revision		Revision as of 22:12, 5 May 2014
Line 44:		Line 44:
	msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long,		msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long,
	ByRef Cancel As Boolean)		ByRef Cancel As Boolean)
	MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to, Prev_increment, Cancel)		MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to,
			Prev_increment, Cancel)
	{{APIComment\|'<Additional overridden code here.>}}		{{APIComment\|'<Additional overridden code here.>}}
	End Sub		End Sub

Chris Kahn: /* Usage Example */

2014-05-05T22:12:03Z

Usage Example

← Older revision		Revision as of 22:12, 5 May 2014
Line 38:		Line 38:
	== Usage Example ==		== Usage Example ==
	This example demonstrates how to produce a dialog box when the calculation progress should be updated.		This example demonstrates how to produce a dialog box when the calculation progress should be updated.
	{{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:04:19Z

Usage Example

← Older revision		Revision as of 22:04, 5 May 2014
Line 37:		Line 37:

	== Usage Example ==		== Usage Example ==
	This example demonstrates how to produce a dialog box when ~~a message~~ should be ~~displayed~~.		This example demonstrates how to produce a dialog box when the calculation progress should be updated.
	{{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:01:30Z

Usage Example

← Older revision		Revision as of 22:01, 5 May 2014
Line 37:		Line 37:

	== Usage Example ==		== Usage Example ==
			This example demonstrates how to produce a dialog box when a message should be displayed.
	{{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-05T21:58:17Z

Usage Example

← Older revision		Revision as of 21:58, 5 May 2014
Line 37:		Line 37:

	== Usage Example ==		== Usage Example ==
	{{APIComment\|'Overrides requested, Create a new class ~~and Inherit~~ WeibullEvents, and set the dataset's ~~Events~~.}}		{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents,}}
			{{APIComment\|'and set the dataset's events.}}
	Private Class myEvents		Private Class myEvents
	Inherits WeibullEvents		Inherits WeibullEvents
Line 44:		Line 45:
	ByRef Cancel As Boolean)		ByRef Cancel As Boolean)
	MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to, Prev_increment, Cancel)		MyBase.UpdateCalculationProgress(sender, msgx_0, msgx_1, pdone, append_to, Prev_increment, Cancel)
	("Additional overridden code here.")		{{APIComment\|'<Additional overridden code here.>}}
	End Sub		End Sub
	End Class		End Class

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

	{{APIComment\|'Update calculation progress}}		{{APIComment\|'Update calculation progress.}}
	ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)		ADS.Events.UpdateCalculationProgress(ADS, "Main Label","Remaining Label", 0.8, False, 0, wasCanceled)

	{{APIComment\|'The "Cancel" checkbox reflects the value of wasCanceled}}		{{APIComment\|'The "Cancel" checkbox reflects the value of wasCanceled}}

← Older revision		Revision as of 17:10, 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 messages regarding the progress of the calculations.</onlyinclude>


			{{Template:API_EventsNote}}

			== Syntax ==
			'''_UpdateCalculationProgress'''(''msgx_0'', ''msgx_1'', ''pdone'', ''append_to'', ''Prev_increment'', {{APIPrefix\|ByRef}} ''Cancel'')

			===Parameters===
			''msgx_0''
			: Required. String. The message to display.

			''msgx_1''
			: Required. String. Additional message to display.

			''pdone''
			: Required. Double. The percentage done, in decimal form (0.00 to 0.99).

			''append_to''
			: Required. Boolean. Indicates whether to append ''pdone'' in the progress display at the rate of ''Prev_increment''; otherwise, ''pdone'' will replace the value.

			''Prev_increment''
			: Required. Double. The value of the incremental value per progress update if ''append_to'' is True. If ''append_to'' is False, this value is ignored.

			''Cancel''
			: Required. Boolean. Indicates whether the calculation process has been cancelled.


			== 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_UpdateCalculationProgress({{APIPrefix\|ByVal}} ''msgx_0'' {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} ''msgx_1'' {{APIPrefix\|As String}}, _
			{{APIPrefix\|ByVal}} ''pdone'' {{APIPrefix\|As Double}}, {{APIPrefix\|ByVal}} ''append_to'' {{APIPrefix\|As Boolean}}, _
			{{APIPrefix\|ByVal}} ''Prev_increment'' {{APIPrefix\|As Double}}, ''Cancel'' {{APIPrefix\|As Boolean}})
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (msgx_0)
			{{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_UpdateCalculationProgress(''msgx_0'' {{APIPrefix\|As String}}, ''msgx_1'' {{APIPrefix\|As String}}, _
			''pdone'' {{APIPrefix\|As Double}}, ''append_to'' {{APIPrefix\|As Boolean}}, _
			''Prev_increment'' {{APIPrefix\|As Double}}, {{APIPrefix\|ByRef}} ''Cancel'' {{APIPrefix\|As Boolean}}) _
			{{APIPrefix\|Handles}} ads.UpdateCalculationProgress
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (msgx_0)
			{{APIPrefix\|End Sub}}