Talk:WeibullDataSet.Message/Notes - Revision history

Kate Racaza: Replaced content with 'DRAFT'

2016-08-11T23:35:25Z

Replaced content with 'DRAFT'

← Older revision		Revision as of 23:35, 11 August 2016
Line 1:		Line 1:
	=DRAFT~~= __NOTOC__~~		DRAFT
	~~{{Template:API}}{{Template:APIBreadcrumb\|.[[WeibullDataSet Class\|WeibullDataSet]]}}~~


	~~<onlyinclude>Occurs when there is a calculation error.</onlyinclude>~~


	'''Remarks''': Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. The event can be raised by the [[WeibullDataSet.Calculate\|Calculate]] or [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times).

	~~== Syntax ==~~
	~~'''_Message'''({{APIPrefix\|ByVal}} ''msg'' {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} ''IsCritical'' {{APIPrefix\|As Boolean}})~~

	~~===Parameters===~~
	~~''msg''~~
	~~: The message to display.~~
	~~''IsCritical''~~
	~~: Indicates whether the message displayed is critical.~~


	~~== Example ==~~
	~~The following example provides a simple demonstration on how to handle a custom event.~~
	~~'''VBA'''~~

	~~{{APIComment\|'Specify a variable to handle the event.}}~~
	~~{{APIPrefix\|Private WithEvents}} wds {{APIPrefix\|As}} WeibullDataSet~~

	~~{{APIPrefix\|Sub}} Main()~~
	~~{{APIComment\|'Associate the event variable with an object.}}~~
	~~{{APIPrefix\|Set}} wds = {{APIPrefix\|New}} WeibullDataSet~~

	~~{{APIComment\|'Set the application to handle custom events.}}~~
	~~wds.UseEvents = True~~

	~~{{APIComment\|'To raise the event, call the Calculate method without defining a data set. }}~~
	~~wds.Calculate~~
	~~Msgbox({{APIString\|"End"}})~~
	~~{{APIPrefix\|End Sub}}~~
	~~{{APIComment\|'----------------------------}}~~

	~~{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})~~
	~~{{APIComment\|'<Add code here to handle the event.>}}~~
	~~MsgBox (msg)~~
	~~{{APIPrefix\|End Sub}}~~

Kate Racaza at 23:31, 11 August 2016

2016-08-11T23:31:24Z

← Older revision		Revision as of 23:31, 11 August 2016
Line 3:		Line 3:


	<onlyinclude>Occurs when there is ~~insufficient data to estimate the parameters of~~ a ~~distribution~~.</onlyinclude> The Message event can be raised by the [[WeibullDataSet.Calculate\|Calculate]] or [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times.)		<onlyinclude>Occurs when there is a calculation error.</onlyinclude>


	'''Remarks''': Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. ~~See~~ the ~~example below~~.		'''Remarks''': Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. The event can be raised by the [[WeibullDataSet.Calculate\|Calculate]] or [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times).

	== Syntax ==		== Syntax ==
Line 13:		Line 13:
	===Parameters===		===Parameters===
	''msg''		''msg''
	: The ~~main~~ display ~~label~~.		: The message to display.
	''IsCritical''		''IsCritical''
	: Indicates whether the message displayed is critical.		: Indicates whether the message displayed is critical.
Line 38:		Line 38:
	{{APIComment\|'----------------------------}}		{{APIComment\|'----------------------------}}

	{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} ~~Msg~~ {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox (~~{{APIString\|"Message event"}}~~)		MsgBox (msg)
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

Kate Racaza at 21:57, 11 August 2016

2016-08-11T21:57:18Z

← Older revision		Revision as of 21:57, 11 August 2016
Line 3:		Line 3:


	<onlyinclude>Occurs when there is insufficient data to estimate the parameters of a distribution.</onlyinclude> The Message event can be raised by the ~~following class methods:~~		<onlyinclude>Occurs when there is insufficient data to estimate the parameters of a distribution.</onlyinclude> The Message event can be raised by the [[WeibullDataSet.Calculate\|Calculate]] or [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] method (the event is raised for each distribution that is considered in the goodness-of-fit analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times.)

	*<code>Calculate</code>
	*<code>CalculateBestFit</code> (The event is raised for each distribution that is considered in the analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times.)


	~~'''Remarks'''~~

	~~Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. See the following example.~~

			'''Remarks''': Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. See the example below.

	== Syntax ==		== Syntax ==

Kate Racaza at 21:49, 11 August 2016

2016-08-11T21:49:24Z

← Older revision		Revision as of 21:49, 11 August 2016
Line 1:		Line 1:
	=DRAFT= __NOTOC__		=DRAFT= __NOTOC__
			{{Template:API}}{{Template:APIBreadcrumb\|.[[WeibullDataSet Class\|WeibullDataSet]]}}

	~~Occurs when the <code>Calculate</code> or <code>CalculateBestFit</code> method is called but no data set has been defined or there is insufficient data to calculate the parameters of a distribution.~~

	~~To handle custom events, set~~ the <code>~~UseEvents~~</code> ~~property of the object to True. The~~ <code>~~Calculate~~</code> ~~method raises~~ the ~~event once~~, ~~when it~~ is ~~unable~~ to ~~calculate~~ the parameters of the ~~data~~. ~~The~~ <code>~~CalculateBestFit~~</code> ~~method raises~~ the ~~event for each distribution that is selected~~ to ~~be included in~~ the ~~analysis~~.		<onlyinclude>Occurs when there is insufficient data to estimate the parameters of a distribution.</onlyinclude> The Message event can be raised by the following class methods:

			*<code>Calculate</code>
			*<code>CalculateBestFit</code> (The event is raised for each distribution that is considered in the analysis; e.g., if 3 distributions are being considered and there is insufficient data to estimate the parameters of all 3, then the event is raised 3 times.)


			'''Remarks'''

			Instead of using the default event procedure, you can execute a custom procedure by setting the <code>UseEvents</code> property of the object to true. See the following example.


	== Syntax ==		== Syntax ==

Kate Racaza at 21:08, 11 August 2016

2016-08-11T21:08:08Z

← Older revision		Revision as of 21:08, 11 August 2016
Line 10:		Line 10:
	===Parameters===		===Parameters===
	''msg''		''msg''
	: The ~~error message~~.		: The main display label.
	''IsCritical''		''IsCritical''
	: Indicates whether the message displayed is critical.		: Indicates whether the message displayed is critical.

Kate Racaza at 21:00, 11 August 2016

2016-08-11T21:00:37Z

← Older revision		Revision as of 21:00, 11 August 2016
Line 10:		Line 10:
	===Parameters===		===Parameters===
	''msg''		''msg''
	: The ~~main display label~~.		: The error message.
	''IsCritical''		''IsCritical''
	: Indicates whether the message displayed is critical.		: Indicates whether the message displayed is critical.

Kate Racaza at 20:55, 11 August 2016

2016-08-11T20:55:36Z

← Older revision		Revision as of 20:55, 11 August 2016
Line 37:		Line 37:
	{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox ({{APIString\|"Message event."}})		MsgBox ({{APIString\|"Message event"}})
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

Kate Racaza at 20:46, 11 August 2016

2016-08-11T20:46:45Z

← Older revision		Revision as of 20:46, 11 August 2016
Line 37:		Line 37:
	{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox ({{APIString\|"~~Custom~~ event ~~procedure working~~."}})		MsgBox ({{APIString\|"Message event."}})
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

Kate Racaza at 16:07, 11 August 2016

2016-08-11T16:07:17Z

← Older revision		Revision as of 16:07, 11 August 2016
Line 3:		Line 3:
	Occurs when the <code>Calculate</code> or <code>CalculateBestFit</code> method is called but no data set has been defined or there is insufficient data to calculate the parameters of a distribution.		Occurs when the <code>Calculate</code> or <code>CalculateBestFit</code> method is called but no data set has been defined or there is insufficient data to calculate the parameters of a distribution.

	To handle custom events, set the <code>UseEvents</code> property of the object to True. The <code>Calculate</code> method raises the event once, when it is unable to calculate the parameters of the data. The <code>CalculateBestFit</code> method raises the event ~~once~~ for each distribution that is selected to be included in the analysis ~~that has no or insufficient data~~.		To handle custom events, set the <code>UseEvents</code> property of the object to True. The <code>Calculate</code> method raises the event once, when it is unable to calculate the parameters of the data. The <code>CalculateBestFit</code> method raises the event for each distribution that is selected to be included in the analysis.

	== Syntax ==		== Syntax ==

Kate Racaza at 15:43, 11 August 2016

2016-08-11T15:43:05Z

← Older revision		Revision as of 15:43, 11 August 2016
Line 1:		Line 1:
	=DRAFT=		=DRAFT= __NOTOC__

			Occurs when the <code>Calculate</code> or <code>CalculateBestFit</code> method is called but no data set has been defined or there is insufficient data to calculate the parameters of a distribution.

	~~Occurs when~~ the <code>~~Calculate~~</code> or <code>~~CalculateBestFit~~</code> method is ~~called but no~~ data ~~set has been defined~~. The ~~application~~ is ~~unable~~ to ~~calculate~~ the ~~parameters when there is~~ no data.		To handle custom events, set the <code>UseEvents</code> property of the object to True. The <code>Calculate</code> method raises the event once, when it is unable to calculate the parameters of the data. The <code>CalculateBestFit</code> method raises the event once for each distribution that is selected to be included in the analysis that has no or insufficient data.

	== Syntax ==		== Syntax ==
Line 15:		Line 16:

	== Example ==		== Example ==
			The following example provides a simple demonstration on how to handle a custom event.
	'''VBA'''		'''VBA'''

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

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

	{{APIComment\|'Set the ~~API~~ to ~~use~~ custom events.}}		{{APIComment\|'Set the application to handle custom events.}}
	wds.UseEvents = True		wds.UseEvents = True

	{{APIComment\|'~~Call~~ the Calculate method without defining a data set. }}		{{APIComment\|'To raise the event, call the Calculate method without defining a data set. }}
	wds.Calculate		wds.Calculate
	Msgbox({{APIString\|"End"}})		Msgbox({{APIString\|"End"}})
	{{APIPrefix\|End Sub()}}		{{APIPrefix\|End Sub}}
			{{APIComment\|'----------------------------}}
	~~{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})~~
	{{APIComment\|'~~Add custom code here to handle the event.~~}}
	~~{{APIComment\|'...}}~~
	~~{{APIComment\|'...}}~~
	~~MsgBox ({{APIString\|"Custom event procedure working."}})~~
	~~{{APIPrefix\|End Sub}}~~





	{{~~APIComment~~\|~~'Create a new class and inherit WeibullEvents.~~}}		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	~~Private Class myEvents~~		{{APIComment\|'<Add code here to handle the event.>}}
	~~Inherits WeibullEvents~~		MsgBox ({{APIString\|"Custom event procedure working."}})
	{{~~APIComment~~\|~~'Request overrides.~~}}		{{APIPrefix\|End Sub}}
	~~Public Overrides Sub Message(sender As WeibullDataSet, sMsg As String, AdditionalInfo~~ As String, IsCritical As Boolean)
	~~MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)~~
	{{APIComment\|'<Add ~~additional~~ code here.>}}
	~~End Sub~~
	~~End Class~~

	{{~~APIComment~~\|~~'Declare a new WeibullDataSet~~.}}
	~~Dim WDS as New WeibullDataSet~~

	{{~~APIComment~~\|~~'Use the created myEvents class in place of the one created by the dataset.}}~~
	~~WDS.Events = New myEvents~~

	~~{{APIComment\|'Show a prompt with the respective strings. The additional code will also run.~~}}
	~~WDS.Events.Message(WDS, "Message1", "AdditionalInfo1", False)~~

← Older revision		Revision as of 20:55, 11 August 2016
Line 37:		Line 37:
	{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox ({{APIString\|"Message event."}})		MsgBox ({{APIString\|"Message event"}})
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

← Older revision		Revision as of 20:46, 11 August 2016
Line 37:		Line 37:
	{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox ({{APIString\|"~~Custom~~ event ~~procedure working~~."}})		MsgBox ({{APIString\|"Message event."}})
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

← Older revision		Revision as of 15:43, 11 August 2016
Line 1:		Line 1:
	=DRAFT=		=DRAFT= __NOTOC__

			Occurs when the <code>Calculate</code> or <code>CalculateBestFit</code> method is called but no data set has been defined or there is insufficient data to calculate the parameters of a distribution.

	~~Occurs when~~ the <code>~~Calculate~~</code> or <code>~~CalculateBestFit~~</code> method is ~~called but no~~ data ~~set has been defined~~. The ~~application~~ is ~~unable~~ to ~~calculate~~ the ~~parameters when there is~~ no data.		To handle custom events, set the <code>UseEvents</code> property of the object to True. The <code>Calculate</code> method raises the event once, when it is unable to calculate the parameters of the data. The <code>CalculateBestFit</code> method raises the event once for each distribution that is selected to be included in the analysis that has no or insufficient data.

	== Syntax ==		== Syntax ==
Line 15:		Line 16:

	== Example ==		== Example ==
			The following example provides a simple demonstration on how to handle a custom event.
	'''VBA'''		'''VBA'''

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

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

	{{APIComment\|'Set the ~~API~~ to ~~use~~ custom events.}}		{{APIComment\|'Set the application to handle custom events.}}
	wds.UseEvents = True		wds.UseEvents = True

	{{APIComment\|'~~Call~~ the Calculate method without defining a data set. }}		{{APIComment\|'To raise the event, call the Calculate method without defining a data set. }}
	wds.Calculate		wds.Calculate
	Msgbox({{APIString\|"End"}})		Msgbox({{APIString\|"End"}})
	{{APIPrefix\|End Sub()}}		{{APIPrefix\|End Sub}}
			{{APIComment\|'----------------------------}}
	~~{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})~~
	{{APIComment\|'~~Add custom code here to handle the event.~~}}
	~~{{APIComment\|'...}}~~
	~~{{APIComment\|'...}}~~
	~~MsgBox ({{APIString\|"Custom event procedure working."}})~~
	~~{{APIPrefix\|End Sub}}~~





	{{~~APIComment~~\|~~'Create a new class and inherit WeibullEvents.~~}}		{{APIPrefix\|Private Sub}} wds_Message({{APIPrefix\|ByVal}} Msg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} IsCritical {{APIPrefix\|As Boolean}})
	~~Private Class myEvents~~		{{APIComment\|'<Add code here to handle the event.>}}
	~~Inherits WeibullEvents~~		MsgBox ({{APIString\|"Custom event procedure working."}})
	{{~~APIComment~~\|~~'Request overrides.~~}}		{{APIPrefix\|End Sub}}
	~~Public Overrides Sub Message(sender As WeibullDataSet, sMsg As String, AdditionalInfo~~ As String, IsCritical As Boolean)
	~~MyBase.Message(sender, sMsg, AdditionalInfo, IsCritical)~~
	{{APIComment\|'<Add ~~additional~~ code here.>}}
	~~End Sub~~
	~~End Class~~

	{{~~APIComment~~\|~~'Declare a new WeibullDataSet~~.}}
	~~Dim WDS as New WeibullDataSet~~

	{{~~APIComment~~\|~~'Use the created myEvents class in place of the one created by the dataset.}}~~
	~~WDS.Events = New myEvents~~

	~~{{APIComment\|'Show a prompt with the respective strings. The additional code will also run.~~}}
	~~WDS.Events.Message(WDS, "Message1", "AdditionalInfo1", False)~~