WeibullDataSet.GetDistrParameters - Revision history

Kate Racaza at 23:40, 6 September 2016

2016-09-06T23:40:35Z

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

Kate Racaza at 18:19, 22 August 2016

2016-08-22T18:19:23Z

← Older revision		Revision as of 18:19, 22 August 2016
Line 70:		Line 70:
	InputInfo {{APIPrefix\|As DistrParametersInput}}, _		InputInfo {{APIPrefix\|As DistrParametersInput}}, _
	{{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters		{{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters
			{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox (sMsg)		MsgBox (sMsg)
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

Kate Racaza at 18:11, 22 August 2016

2016-08-22T18:11:45Z

← Older revision		Revision as of 18:11, 22 August 2016
Line 9:		Line 9:

	== Syntax ==		== Syntax ==
	'''_GetDistrParameters'''(''sMsg'', ''~~GetOnlyOneParameter'', ''ParamCount'', {{APIPrefix\|ByRef}} ''Params()~~'', {{APIPrefix\|ByRef}} ''Cancel'')		'''_GetDistrParameters'''(''sMsg'', ''InputInfo'', {{APIPrefix\|ByRef}} ''Cancel'')

	===Parameters===		===Parameters===
	''sMsg''		''sMsg''
	: Required. String. The message to display.		: Required. String. The message to display.
	''~~GetOnlyOneParameter''~~		''InputInfo''
	~~: Required. Boolean. Indicates whether to get a value for only one parameter. Default value = False.~~		: Required. An array of [[DistrParametersInput Class\|DistrParametersInput()]] type objects that represent the model's parameters.
	~~''ParamCount''~~
	~~: Required. Integer. The number of parameters to update.~~
	~~''Params()~~''
	: Required. An array of [[~~ParamInputInfo~~ Class\|~~ParamInputInfo~~]] type objects that represent the model's parameters.
	''Cancel''		''Cancel''
	: Required. Boolean. Indicates whether the input was cancelled. Default value = False.		: Required. Boolean. Indicates whether the input was cancelled. Default value = False.
Line 45:		Line 41:

	{{APIComment\|'----------------------------}}		{{APIComment\|'----------------------------}}
	{{APIPrefix\|Private Sub}} wds_GetDistrParameters({{APIPrefix\|ByVal}} sMsg {{APIPrefix\|As String~~}}, {{APIPrefix\|ByVal}} GetOnlyOneParameter {{APIPrefix\|As Boolean~~}}, _		{{APIPrefix\|Private Sub}} wds_GetDistrParameters({{APIPrefix\|ByVal}} sMsg {{APIPrefix\|As String}}, _
	{{APIPrefix\|ByVal}} ~~ParamCount {{APIPrefix\|As Long}}, Params()~~ {{APIPrefix\|As SynthesisAPI.~~ParamInputInfo~~}}, Cancel {{APIPrefix\|As Boolean}})		{{APIPrefix\|ByVal}} InputInfo {{APIPrefix\|As SynthesisAPI.DistrParametersInput}}, _
			Cancel {{APIPrefix\|As Boolean}})
	{{APIComment\|'<Add code here to handle the event.>}}		{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox (sMsg)		MsgBox (sMsg)
Line 70:		Line 67:

	{{APIComment\|'----------------------------}}		{{APIComment\|'----------------------------}}
	{{APIPrefix\|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix\|As String}}, ~~GetOnlyOneParameter~~ {{APIPrefix\|As ~~Boolean}}, ParamCount {{APIPrefix\|As Integer~~}}, _		{{APIPrefix\|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix\|As String}}, _
	~~{{APIPrefix\|ByRef}} Params() {{APIPrefix\|As ParamInputInfo}},~~ {{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters		InputInfo {{APIPrefix\|As DistrParametersInput}}, _
	~~{{APIComment\|'<Add code here to handle the event.>}}~~		{{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters

	MsgBox (sMsg)		MsgBox (sMsg)
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

Kate Racaza at 21:15, 16 August 2016

2016-08-16T21:15:17Z

← Older revision		Revision as of 21:15, 16 August 2016
Line 9:		Line 9:

	== Syntax ==		== Syntax ==
	'''_GetDistrParameters'''(~~{{APIPrefix\|ByVal}}~~ ''sMsg'', ~~{{APIPrefix\|ByVal}}~~ ''GetOnlyOneParameter'', ~~{{APIPrefix\|ByVal}}~~ ''ParamCount'', {{APIPrefix\|ByRef}} ''Params()'', {{APIPrefix\|ByRef}} ''Cancel'')		'''_GetDistrParameters'''(''sMsg'', ''GetOnlyOneParameter'', ''ParamCount'', {{APIPrefix\|ByRef}} ''Params()'', {{APIPrefix\|ByRef}} ''Cancel'')

	===Parameters===		===Parameters===

Kate Racaza at 16:47, 16 August 2016

2016-08-16T16:47:25Z

← Older revision		Revision as of 16:47, 16 August 2016
Line 22:		Line 22:
	''Cancel''		''Cancel''
	: Required. Boolean. Indicates whether the input was cancelled. Default value = False.		: Required. Boolean. Indicates whether the input was cancelled. Default value = False.


			== 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}} wds {{APIPrefix\|As}} WeibullDataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private 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, call the Calculate method without defining a data set. }}
			wds.Calculate
			Msgbox({{APIString\|"End"}})
			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} wds_GetDistrParameters({{APIPrefix\|ByVal}} sMsg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} GetOnlyOneParameter {{APIPrefix\|As Boolean}}, _
			{{APIPrefix\|ByVal}} ParamCount {{APIPrefix\|As Long}}, Params() {{APIPrefix\|As SynthesisAPI.ParamInputInfo}}, Cancel {{APIPrefix\|As Boolean}})
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (sMsg)
			{{APIPrefix\|End Sub}}

			'''VB.NET'''

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

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

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

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

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix\|As String}}, GetOnlyOneParameter {{APIPrefix\|As Boolean}}, ParamCount {{APIPrefix\|As Integer}}, _
			{{APIPrefix\|ByRef}} Params() {{APIPrefix\|As ParamInputInfo}}, {{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (sMsg)
			{{APIPrefix\|End Sub}}

Kate Racaza at 16:19, 16 August 2016

2016-08-16T16:19:27Z

← Older revision		Revision as of 16:19, 16 August 2016
Line 9:		Line 9:

	== Syntax ==		== Syntax ==
	'''_GetDistrParameters'''({{APIPrefix\|ByVal}} ''sMsg'' ~~{{APIPrefix\|As String}}~~, {{APIPrefix\|ByVal}} ''GetOnlyOneParameter'' ~~{{APIPrefix\|As Boolean}}~~, _		'''_GetDistrParameters'''({{APIPrefix\|ByVal}} ''sMsg'', {{APIPrefix\|ByVal}} ''GetOnlyOneParameter'', {{APIPrefix\|ByVal}} ''ParamCount'', {{APIPrefix\|ByRef}} ''Params()'', {{APIPrefix\|ByRef}} ''Cancel'')
	{{APIPrefix\|ByVal}} ''ParamCount'' {{APIPrefix\|~~As Long~~}}, ''Params()'' {{APIPrefix\|~~As ParamInputInfo~~}}, ''Cancel'' ~~{{APIPrefix\|As Boolean}}~~)

	===Parameters===		===Parameters===
	''sMsg''		''sMsg''
	: The message to display.		: Required. String. The message to display.
	''GetOnlyOneParameter''		''GetOnlyOneParameter''
	: ~~The prompt~~ for only one parameter.		: Required. Boolean. Indicates whether to get a value for only one parameter. Default value = False.
	''ParamCount''		''ParamCount''
	: The number of parameters to update.		: Required. Integer. The number of parameters to update.
	''Params()''		''Params()''
	: ~~The~~ array of [[ParamInputInfo Class\|ParamInputInfo]] objects ~~to update~~.		: Required. An array of [[ParamInputInfo Class\|ParamInputInfo]] type objects that represent the model's parameters.
	''Cancel''		''Cancel''
	: Indicates whether the input was cancelled.		: Required. Boolean. Indicates whether the input was cancelled. Default value = False.

Kate Racaza at 19:03, 12 August 2016

2016-08-12T19:03:19Z

← Older revision		Revision as of 19:03, 12 August 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[WeibullDataSet Class\|WeibullDataSet]]}}
	{{Template:InProgress}}		{{Template:InProgress}}


			<onlyinclude>Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.</onlyinclude>


			{{Template:API_EventsNote}}

			== Syntax ==
			'''_GetDistrParameters'''({{APIPrefix\|ByVal}} ''sMsg'' {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} ''GetOnlyOneParameter'' {{APIPrefix\|As Boolean}}, _
			{{APIPrefix\|ByVal}} ''ParamCount'' {{APIPrefix\|As Long}}, ''Params()'' {{APIPrefix\|As ParamInputInfo}}, ''Cancel'' {{APIPrefix\|As Boolean}})

			===Parameters===
			''sMsg''
			: The message to display.
			''GetOnlyOneParameter''
			: The prompt for only one parameter.
			''ParamCount''
			: The number of parameters to update.
			''Params()''
			: The array of [[ParamInputInfo Class\|ParamInputInfo]] objects to update.
			''Cancel''
			: Indicates whether the input was cancelled.

Kate Racaza: moved WeibullEvents.GetDistrParameters to WeibullDataSet.GetDistrParameters: Change in API structure

2016-08-12T18:38:08Z

moved WeibullEvents.GetDistrParameters to WeibullDataSet.GetDistrParameters: Change in API structure

← Older revision	Revision as of 18:38, 12 August 2016
(No difference)

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

2016-05-06T15:26:02Z

Replaced content with '{{Template:API}}{{Template:APIBreadcrumb}} {{Template:InProgress}}'

← Older revision		Revision as of 15:26, 6 May 2016
Line 1:		Line 1:
	{{Template:~~APIClass\|WeibullEvents Class\|WeibullEvents~~}}		{{Template:API}}{{Template:APIBreadcrumb}}
	~~Displays a prompt for entering customized parameters. This is called when the Calculate method is called and there is insufficient data to fit a model.~~		{{Template:InProgress}}

	~~== Syntax ==~~
	~~<ul><li>GetDistrParameters(~~
	{{~~APIName\|sender~~}}
	{{~~APIPrefix\|As}}~~
	~~{{APIName\|[[WeibullDataSet Class\|WeibullDataSet]],}}~~
	~~{{APIName\|sMsg}}~~
	~~{{APIPrefix\|As String}}~~
	~~{{APIName\|,}}~~
	~~{{APIName\|GetOnlyOneParameter}}~~
	~~{{APIPrefix\|As Boolean}}~~
	~~{{APIName\|,}}~~
	~~{{APIName\|Params}}~~
	~~{{APIPrefix\|As}}~~
	~~{{APIName\|List(}}~~
	~~{{APIPrefix\|Of}}~~
	~~{{APIName\|[[ParamInputInfo Class\|ParamInputInfo]] )}}~~
	~~{{APIName\|, Cancel}}~~
	~~{{APIPrefix\|As Boolean}})</li></ul>~~

	~~Parameters~~
	:~~''sender'': A [[WeibullDataSet Class\|WeibullDataSet]] object.~~

	~~:''sMsg'': The main display label.~~

	~~:''GetOnlyOneParameter'': The prompt for only one parameter.~~

	:''Params'': A list of [[ParamInputInfo Class\|ParamInputInfo]] objects that would be updated by this prompt. After processing with this event handler, the Value of each ParamInputInfo object will be updated.

	~~:''Cancel'': If the prompt was closed by any means other than clicking "Okay," this value will be set to True.~~

	~~== Usage Example ==~~

	~~{{APIComment\|'Overrides requested. Create a new class, inherit WeibullEvents, and set the dataset's events.}}~~
	~~Private Class myEvents~~
	~~Inherits WeibullEvents~~
	~~Public Overrides Sub GetDistrParameters(sender As WeibullDataSet, sMsg As String,~~
	~~GetOnlyOneParamater As Boolean, Params As List(Of ParamInputInfo), ByRef Cancel As Boolean)~~
	~~MyBase.GetDistrParameters(sender, sMsg, GetOnlyOneParamater, Params, Cancel)~~
	~~MessageBox.Show("Additional overridden code here.")~~
	~~End Sub~~
	~~End Class~~

	~~{{APIComment\|'Declare the 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\|'Creates a new list of [[ParamInputInfo Class\|ParamInputInfo]] objects. Populate the list.}}~~
	~~Dim Params As New List(Of ParamInputInfo)~~
	~~Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))~~
	~~Params.Add(New ParamInputInfo("Param2", 0, Double.MaxValue, False, True))~~

	~~{{APIComment\|'Create a Boolean for return of "Cancel" parameter.}}~~
	~~Dim wasCanceled As Boolean~~

	~~{{APIComment\|'Prompt user to input the parameters.}}~~
	~~WDS.Events.GetDistrParameters(WDS, "Message1", True, Params, wasCanceled)~~

	~~{{APIComment\|'The new Parameter values are in their respective ParamInputInfo.Value variables.~~}}
	~~Dim NewParameter1value As Double~~
	~~Dim NewParameter2value As Double~~
	~~If Not wasCanceled Then~~
	~~NewParameter1value = Params(0).Value~~
	~~NewParameter2value = Params(1).Value~~
	~~End If~~

Chris Kahn at 16:53, 15 May 2014

2014-05-15T16:53:29Z

← Older revision		Revision as of 16:53, 15 May 2014
Line 50:		Line 50:
	WDS.Events = New myEvents		WDS.Events = New myEvents

	{{APIComment\|'Creates a new list of ParamInputInfo. Populate the list.}}		{{APIComment\|'Creates a new list of [[ParamInputInfo Class\|ParamInputInfo]] objects. Populate the list.}}
	Dim Params As New List(Of ParamInputInfo)		Dim Params As New List(Of ParamInputInfo)
	Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))		Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))

← Older revision		Revision as of 18:19, 22 August 2016
Line 70:		Line 70:
	InputInfo {{APIPrefix\|As DistrParametersInput}}, _		InputInfo {{APIPrefix\|As DistrParametersInput}}, _
	{{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters		{{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters
			{{APIComment\|'<Add code here to handle the event.>}}
	MsgBox (sMsg)		MsgBox (sMsg)
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}

← Older revision		Revision as of 16:47, 16 August 2016
Line 22:		Line 22:
	''Cancel''		''Cancel''
	: Required. Boolean. Indicates whether the input was cancelled. Default value = False.		: Required. Boolean. Indicates whether the input was cancelled. Default value = False.


			== 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}} wds {{APIPrefix\|As}} WeibullDataSet

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private 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, call the Calculate method without defining a data set. }}
			wds.Calculate
			Msgbox({{APIString\|"End"}})
			{{APIPrefix\|End Sub}}

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} wds_GetDistrParameters({{APIPrefix\|ByVal}} sMsg {{APIPrefix\|As String}}, {{APIPrefix\|ByVal}} GetOnlyOneParameter {{APIPrefix\|As Boolean}}, _
			{{APIPrefix\|ByVal}} ParamCount {{APIPrefix\|As Long}}, Params() {{APIPrefix\|As SynthesisAPI.ParamInputInfo}}, Cancel {{APIPrefix\|As Boolean}})
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (sMsg)
			{{APIPrefix\|End Sub}}

			'''VB.NET'''

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

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

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

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

			{{APIComment\|'----------------------------}}
			{{APIPrefix\|Private Sub}} wds_GetDistrParameters(sMsg {{APIPrefix\|As String}}, GetOnlyOneParameter {{APIPrefix\|As Boolean}}, ParamCount {{APIPrefix\|As Integer}}, _
			{{APIPrefix\|ByRef}} Params() {{APIPrefix\|As ParamInputInfo}}, {{APIPrefix\|ByRef}} Cancel {{APIPrefix\|As Boolean}}) {{APIPrefix\|Handles}} wds.GetDistrParameters
			{{APIComment\|'<Add code here to handle the event.>}}
			MsgBox (sMsg)
			{{APIPrefix\|End Sub}}