CModel.Bounds Parameters - Revision history

Kate Racaza at 19:02, 18 August 2016

2016-08-18T19:02:15Z

← Older revision		Revision as of 19:02, 18 August 2016
Line 4:		Line 4:
	<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude>		<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude>

	You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.
			{{Template:API_BoundsNote}}

	== Syntax==		== Syntax==

Kate Racaza at 15:14, 8 April 2016

2016-04-08T15:14:50Z

← Older revision		Revision as of 15:14, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated ~~[[CModel_Class\|~~cModel]] object. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude>		<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude>

	You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.		You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.

Kate Racaza at 23:34, 7 April 2016

2016-04-07T23:34:35Z

← Older revision		Revision as of 23:34, 7 April 2016
Line 2:		Line 2:


	<onlyinclude>Calculates the confidence bounds on the parameter estimates. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object ~~array~~ that ~~contains contains~~ the ~~values~~.'''</onlyinclude>		<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated [[CModel_Class\|cModel]] object. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude>

	You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.		You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.

Kate Racaza at 21:21, 13 November 2015

2015-11-13T21:21:10Z

← Older revision		Revision as of 21:21, 13 November 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:cModel.Bounds Parameters}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}		{{DISPLAYTITLE:cModel.Bounds Parameters}}{{Template:API}}{{Template:APIBreadcrumb\|.[[CModel Class\|cModel]]}}

Kate Racaza at 18:38, 5 November 2015

2015-11-05T18:38:57Z

Kate Racaza at 20:57, 29 July 2015

2015-07-29T20:57:25Z

← Older revision		Revision as of 20:57, 29 July 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:cModel.~~Bounds_Parameters~~}}		{{DISPLAYTITLE:cModel.Bounds Parameters}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}
	{{Template:~~APIClass~~\|CModel Class\|cModel}}
	~~{{Template:CModel~~.~~Bounds Parameters~~.~~Cmt}} {{Template:~~CModel.~~BoundsNote~~.~~Cmt}}~~
			<onlyinclude>Calculates the confidence bounds on the parameter estimates. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object array that contains contains the values.'''</onlyinclude>

			You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations.

	== Syntax==		== Syntax==
	*Bounds_Parameters() {{APIPrefix\|As}} ~~List~~({{APIPrefix\|Of}} [[ParamBoundsValues ~~Class~~\|~~ParamBoundsValues]]~~ )		'''.Bounds_Parameters()'''


			== Example ==
			'''VBA'''

			{{APIComment\|...}}

			{{APIComment\|'Add code to get an existing model or create a new one.}}
			{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel
			{{APIComment\|...}}

			{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
			{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
			{{APIPrefix\|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

			{{APIComment\|'Calculate the bounds on the model's parameters.}}
			{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
			ResultValue = AModel.Bounds_Parameters

			{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
			{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
			{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
			{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
			ParamName = ResultValue(0).ParamName
			ParamUpperVal = ResultValue(0).Upper
			ParamLowerVal = ResultValue(0).Lower
			MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)

	~~== Usage Example ==~~		'''VB.NET'''
	~~<div style="margin-right: 150px">~~
	{{APIComment\|~~'Declare a new repository connection object~~.}}		{{APIComment\|...}}
	~~Dim MyRepository As New Repository~~
			{{APIComment\|'Add code to get an existing model or create a new one.}}
	{{APIComment\|'~~Connect~~ to ~~the Synthesis repository~~.}}		{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel
	Dim ~~Success~~ As ~~Boolean = False~~		{{APIComment\|...}}
	~~Success = MyRepository~~.~~ConnectToRepository("RepositoryFileNamePath")~~
			{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
	{{APIComment\|'~~Get~~ the ~~model with the numerical ID 15~~.}}		{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
	Dim ~~AModel as cModel~~		AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
	AModel ~~= MyRepository~~.~~GetModel~~(15)
			{{APIComment\|'Calculate the bounds on the model's parameters.}}
	{{APIComment\|'~~Get~~ the ~~confidence~~ bounds on the parameters ~~of that model~~.}}		{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
	Dim ~~ModelBoundsParameters~~() as ParamBoundsValues		ResultValue = AModel.Bounds_Parameters
	~~ModelBoundsParameters~~ = AModel.Bounds_Parameters
			{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
	{{APIComment\|'~~Save~~ the ~~lower bound~~ on the first parameter.}}		{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
	Dim ~~lower as double~~		{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
	~~lower~~ = ~~ModelBoundsParameters~~.Lower		{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
	~~</div>~~		ParamName = ResultValue(0).ParamName
			ParamUpperVal = ResultValue(0).Upper
			ParamLowerVal = ResultValue(0).Lower
			MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)

Chris Kahn: /* Usage Example */

2014-05-27T22:18:08Z

Usage Example

← Older revision		Revision as of 22:18, 27 May 2014
Line 8:		Line 8:
	== Usage Example ==		== Usage Example ==
	<div style="margin-right: 150px">		<div style="margin-right: 150px">
	{{APIComment\|'Declare a new repository connection ~~class~~.}}		{{APIComment\|'Declare a new repository connection object.}}
	Dim MyRepository As New Repository		Dim MyRepository As New Repository

Chris Kahn at 16:49, 15 May 2014

2014-05-15T16:49:28Z

← Older revision		Revision as of 16:49, 15 May 2014
Line 7:		Line 7:

	== Usage Example ==		== Usage Example ==
			<div style="margin-right: 150px">
	{{APIComment\|'Declare a new repository connection class.}}		{{APIComment\|'Declare a new repository connection class.}}
	Dim MyRepository As New Repository		Dim MyRepository As New Repository
Line 25:		Line 26:
	Dim lower as double		Dim lower as double
	lower = ModelBoundsParameters.Lower		lower = ModelBoundsParameters.Lower
			</div>

Chris Kahn: /* Usage Example */

2014-04-17T23:49:45Z

Usage Example

← Older revision		Revision as of 23:49, 17 April 2014
Line 8:		Line 8:
	== Usage Example ==		== Usage Example ==
	{{APIComment\|'Declare a new repository connection class.}}		{{APIComment\|'Declare a new repository connection class.}}
	~~Private WithEvents~~ MyRepository As New Repository		Dim MyRepository As New Repository

	{{APIComment\|'Connect to the Synthesis repository.}}		{{APIComment\|'Connect to the Synthesis repository.}}

Chris Kahn: /* Usage Example */

2014-04-17T23:49:22Z

Usage Example

← Older revision		Revision as of 20:57, 29 July 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:cModel.~~Bounds_Parameters~~}}		{{DISPLAYTITLE:cModel.Bounds Parameters}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}
	{{Template:~~APIClass~~\|CModel Class\|cModel}}
	~~{{Template:CModel~~.~~Bounds Parameters~~.~~Cmt}} {{Template:~~CModel.~~BoundsNote~~.~~Cmt}}~~
			<onlyinclude>Calculates the confidence bounds on the parameter estimates. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object array that contains contains the values.'''</onlyinclude>

			You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations.

	== Syntax==		== Syntax==
	*Bounds_Parameters() {{APIPrefix\|As}} ~~List~~({{APIPrefix\|Of}} [[ParamBoundsValues ~~Class~~\|~~ParamBoundsValues]]~~ )		'''.Bounds_Parameters()'''


			== Example ==
			'''VBA'''

			{{APIComment\|...}}

			{{APIComment\|'Add code to get an existing model or create a new one.}}
			{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel
			{{APIComment\|...}}

			{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
			{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
			{{APIPrefix\|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

			{{APIComment\|'Calculate the bounds on the model's parameters.}}
			{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
			ResultValue = AModel.Bounds_Parameters

			{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
			{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
			{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
			{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
			ParamName = ResultValue(0).ParamName
			ParamUpperVal = ResultValue(0).Upper
			ParamLowerVal = ResultValue(0).Lower
			MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)

	~~== Usage Example ==~~		'''VB.NET'''
	~~<div style="margin-right: 150px">~~
	{{APIComment\|~~'Declare a new repository connection object~~.}}		{{APIComment\|...}}
	~~Dim MyRepository As New Repository~~
			{{APIComment\|'Add code to get an existing model or create a new one.}}
	{{APIComment\|'~~Connect~~ to ~~the Synthesis repository~~.}}		{{APIPrefix\|Dim}} AModel {{APIPrefix\|As New}} cModel
	Dim ~~Success~~ As ~~Boolean = False~~		{{APIComment\|...}}
	~~Success = MyRepository~~.~~ConnectToRepository("RepositoryFileNamePath")~~
			{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
	{{APIComment\|'~~Get~~ the ~~model with the numerical ID 15~~.}}		{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
	Dim ~~AModel as cModel~~		AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
	AModel ~~= MyRepository~~.~~GetModel~~(15)
			{{APIComment\|'Calculate the bounds on the model's parameters.}}
	{{APIComment\|'~~Get~~ the ~~confidence~~ bounds on the parameters ~~of that model~~.}}		{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
	Dim ~~ModelBoundsParameters~~() as ParamBoundsValues		ResultValue = AModel.Bounds_Parameters
	~~ModelBoundsParameters~~ = AModel.Bounds_Parameters
			{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
	{{APIComment\|'~~Save~~ the ~~lower bound~~ on the first parameter.}}		{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
	Dim ~~lower as double~~		{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
	~~lower~~ = ~~ModelBoundsParameters~~.Lower		{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
	~~</div>~~		ParamName = ResultValue(0).ParamName
			ParamUpperVal = ResultValue(0).Upper
			ParamLowerVal = ResultValue(0).Lower
			MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)

← Older revision		Revision as of 18:38, 5 November 2015
Line 4:		Line 4:
	<onlyinclude>Calculates the confidence bounds on the parameter estimates. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object array that contains contains the values.'''</onlyinclude>		<onlyinclude>Calculates the confidence bounds on the parameter estimates. Returns a '''[[ParamBoundsValues Class\|ParamBoundsValues]]''' object array that contains contains the values.'''</onlyinclude>

	You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations.		You must first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.

	== Syntax==		== Syntax==
Line 11:		Line 11:

	== Example ==		== Example ==
			This example assumes that a published model with ID #47 exists in the repository.

	'''VBA'''		'''VBA'''

	{{APIComment\|...}}		{{APIComment\|...}}

	{{APIComment\|'~~Add code to get an existing~~ model ~~or create a new one~~.}}		{{APIComment\|'Get model ID #47 from project ID #1 in the repository.}}
	{{APIPrefix\|Dim}} AModel {{APIPrefix\|As ~~New~~}} cModel		{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel
	{{~~APIComment~~\|..~~.}}~~		MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} AModel = MyRepository.Model.GetModel(47)

	{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}		{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
	{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String		{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
	{{APIPrefix\|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)		{{APIPrefix\|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

	{{APIComment\|'Calculate the bounds on the model's parameters.}}		{{APIComment\|'Calculate the bounds on the model's parameters.}}
	{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues		{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
	ResultValue = AModel.Bounds_Parameters		ResultValue = AModel.Bounds_Parameters

	{{APIComment\|'Output sample: Display the bounds on the first parameter.}}		{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
	{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}		{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
	{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
	{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
	ParamName = ResultValue(0).ParamName		ParamName = ResultValue(0).ParamName
	ParamUpperVal = ResultValue(0).Upper		ParamUpperVal = ResultValue(0).Upper
	ParamLowerVal = ResultValue(0).Lower		ParamLowerVal = ResultValue(0).Lower
	MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)		MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)

	'''VB.NET'''		'''VB.NET'''
Line 40:		Line 43:
	{{APIComment\|...}}		{{APIComment\|...}}

	{{APIComment\|'~~Add code to get an existing~~ model ~~or create a new one~~.}}		{{APIComment\|'Get model ID #47 from project ID #1 in the repository.}}
	{{APIPrefix\|Dim}} AModel {{APIPrefix\|As ~~New~~}} cModel		{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel
	{{~~APIComment~~\|..~~.}}~~		MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} AModel = MyRepository.Model.GetModel(47)

	{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}		{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
	{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String		{{APIPrefix\|Dim}} ErrorMsg {{APIPrefix\|As}} String
	AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)		AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)

	{{APIComment\|'Calculate the bounds on the model's parameters.}}		{{APIComment\|'Calculate the bounds on the model's parameters.}}
	{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues		{{APIPrefix\|Dim}} ResultValue() {{APIPrefix\|As}} ParamBoundsValues
	ResultValue = AModel.Bounds_Parameters		ResultValue = AModel.Bounds_Parameters

	{{APIComment\|'Output sample: Display the bounds on the first parameter.}}		{{APIComment\|'Output sample: Display the bounds on the first parameter.}}
	{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}		{{APIPrefix\|Dim}} ParamName {{APIPrefix\|As String}}
	{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} ParamUpperVal {{APIPrefix\|As Double}}
	{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} ParamLowerVal {{APIPrefix\|As Double}}
	ParamName = ResultValue(0).ParamName		ParamName = ResultValue(0).ParamName
	ParamUpperVal = ResultValue(0).Upper		ParamUpperVal = ResultValue(0).Upper
	ParamLowerVal = ResultValue(0).Lower		ParamLowerVal = ResultValue(0).Lower
	MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)		MsgBox (ParamName & {{APIString\|": "}} & ParamUpperVal & {{APIString\|" and "}} & ParamLowerVal)