CModel.SetConfidenceLevel: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:cModel.SetConfidenceLevel}}{{Template:API}}{{Template:APIBreadcrumb | {{DISPLAYTITLE:cModel.SetConfidenceLevel}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}} | ||
<onlyinclude> | <onlyinclude>Sets the confidence level to use in confidence bounds calculations for published models. Returns a '''Boolean''' value; when true, indicates that a confidence level has been set.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 22: | Line 22: | ||
== Example == | == Example == | ||
This example assumes that a published model with ID # | This example assumes that a published model with ID #47 exists in the repository. | ||
'''VBA''' | '''VBA''' | ||
| Line 28: | Line 28: | ||
{{APIComment|...}} | {{APIComment|...}} | ||
{{APIComment|'Get model ID # | {{APIComment|'Get model ID #47 from project ID #1 in the repository.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | ||
MyRepository.Project.SetCurrentProject(1) | MyRepository.Project.SetCurrentProject(1) | ||
| Line 35: | Line 35: | ||
{{APIComment|'Set the confidence level to 90% two-sided bounds.}} | {{APIComment|'Set the confidence level to 90% two-sided bounds.}} | ||
{{APIComment|'Declare a string variable for any errors found during this method.}} | {{APIComment|'Declare a string variable for any errors found during this method.}} | ||
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String | |||
{{APIPrefix|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg) | |||
{{APIComment|'Confidence bounds calculations are now possible. For example,}} | {{APIComment|'Confidence bounds calculations are now possible. For example,}} | ||
{{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}} | {{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
{{APIPrefix|Set}} ResultValue = AModel.Bounds_Reliability(100) | |||
'''VB.NET''' | '''VB.NET''' | ||
| Line 47: | Line 47: | ||
{{APIComment|...}} | {{APIComment|...}} | ||
{{APIComment|'Get model ID # | {{APIComment|'Get model ID #47 from project ID #1 in the repository.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | ||
MyRepository.Project.SetCurrentProject(1) | MyRepository.Project.SetCurrentProject(1) | ||
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.}} | ||
{{APIComment|'Declare a string variable for any errors found during this method.}} | {{APIComment|'Declare a string variable for any errors found during this method.}} | ||
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String | |||
AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) | |||
{{APIComment|'Confidence bounds calculations are now possible. For example,}} | {{APIComment|'Confidence bounds calculations are now possible. For example,}} | ||
{{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}} | {{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
ResultValue = AModel.Bounds_Reliability(100) | |||
Latest revision as of 19:02, 9 June 2016
 |
Member of: SynthesisAPI.cModel
Sets the confidence level to use in confidence bounds calculations for published models. Returns a Boolean value; when true, indicates that a confidence level has been set.
Syntax
.SetConfidenceLevel(Level, Sides, UseConfidenceLevelInPercents, ByRef sError)
Parameters
Level
- Required. Double. The confidence level, entered as a percentage.
Sides
- Required. The sides setting (e.g., lower bound) for this confidence level. Can be any ConfBoundsSides constant.
UseConfidenceLevelInPercents
- Required. Boolean. When true, the result is shown as a percentage; otherwise, it is shown as a decimal.
sError
- Required. String. Returns a string for any error results.
Example
This example assumes that a published model with ID #47 exists in the repository.
VBA ... 'Get model ID #47 from project ID #1 in the repository. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) Set AModel = MyRepository.Model.GetModel(47) 'Set the confidence level to 90% two-sided bounds. 'Declare a string variable for any errors found during this method. Dim ErrorMsg As String Call AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg) 'Confidence bounds calculations are now possible. For example, 'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs. Dim ResultValue As BoundsValues Set ResultValue = AModel.Bounds_Reliability(100)
VB.NET ... 'Get model ID #47 from project ID #1 in the repository. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) AModel = MyRepository.Model.GetModel(47) 'Set the confidence level to 90% two-sided bounds. 'Declare a string variable for any errors found during this method. Dim ErrorMsg As String AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) 'Confidence bounds calculations are now possible. For example, 'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs. Dim ResultValue As BoundsValues ResultValue = AModel.Bounds_Reliability(100)