CModel.Bounds FailureRate: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
<onlyinclude>Calculates the bounds on the failure rate at the specified time. Returns a '''[[BoundsValues Class|BoundsValues]]''' object array that contains the result(s).</onlyinclude> | <onlyinclude>Calculates the bounds on the failure rate at the specified time. Returns a '''[[BoundsValues Class|BoundsValues]]''' object array that contains the result(s).</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 21: | Line 21: | ||
== Example == | == Example == | ||
This example assumes that a published model with ID #47 exists in the repository. | |||
'''VBA''' | '''VBA''' | ||
{{APIComment|...}} | {{APIComment|...}} | ||
{{APIComment|' | {{APIComment|'Get model ID #47 from project ID #1 in the repository.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | |||
{{ | 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|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg) | |||
{{APIComment|'Calculate the bounds on the model's failure rate at time = 100.}} | {{APIComment|'Calculate the bounds on the model's failure rate at time = 100.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
{{APIPrefix|Set}} ResultValue = AModel.Bounds_FailureRate(100) | |||
{{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}} | {{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}} | ||
MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower) | |||
'''VB.NET''' | '''VB.NET''' | ||
| Line 44: | Line 46: | ||
{{APIComment|...}} | {{APIComment|...}} | ||
{{APIComment|' | {{APIComment|'Get model ID #47 from project ID #1 in the repository.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | |||
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.}} | ||
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String | |||
AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) | |||
{{APIComment|'Calculate the bounds on the model's failure rate at time = 100.}} | {{APIComment|'Calculate the bounds on the model's failure rate at time = 100.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
ResultValue = AModel.Bounds_FailureRate(100) | |||
{{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}} | {{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}} | ||
MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower) | |||
Revision as of 18:34, 5 November 2015
 |
Member of: SynthesisAPI9.cModel
Calculates the bounds on the failure rate at the specified time. Returns a BoundsValues object array that contains the result(s).
You must first use the 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
.Bounds_FailureRate( Time, CurrentAge, DutyCycle)
Parameters
Time
- Required. Double. The time at which to calculate the failure rate.
CurrentAge
- Optional. Double. The current age. Default value = 0.
DutyCycle
- Optional. Double. The duty cycle. Default value = 1.
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. Dim ErrorMsg As String Call AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg) 'Calculate the bounds on the model's failure rate at time = 100. Dim ResultValue As BoundsValues Set ResultValue = AModel.Bounds_FailureRate(100) 'Output sample: Display the results for the upper and lower confidence bounds. MsgBox (" Upper bound: " & ResultValue.Upper & ", Lower bound: " & ResultValue.Lower)
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. Dim ErrorMsg As String AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) 'Calculate the bounds on the model's failure rate at time = 100. Dim ResultValue As BoundsValues ResultValue = AModel.Bounds_FailureRate(100) 'Output sample: Display the results for the upper and lower confidence bounds. MsgBox (" Upper bound: " & ResultValue.Upper & ", Lower bound: " & ResultValue.Lower)