CModel.Bounds Unreliability: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:cModel.Bounds Unreliability}}{{Template:API}}{{Template:APIBreadcrumb | {{DISPLAYTITLE:cModel.Bounds Unreliability}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}} | ||
<onlyinclude>Calculates the bounds on the probability of failure at | <onlyinclude>Calculates the bounds on the probability of failure at a specified time for an associated cModel object. Returns a '''[[BoundsValues Class|BoundsValues]]''' object that represents the confidence bounds.</onlyinclude> | ||
{{Template:API_BoundsNote}} | |||
== Syntax== | == Syntax== | ||
Line 11: | Line 12: | ||
===Parameters=== | ===Parameters=== | ||
''Time'' | ''Time'' | ||
:Double. The time at which to calculate the probability of failure. | :Required. Double. The time at which to calculate the probability of failure. | ||
''StartAge'' | ''StartAge'' | ||
:Double. The start age. Default value = 0. | :Optional. Double. The start age. Default value = 0. | ||
''DutyCycle'' | ''DutyCycle'' | ||
:Double. The duty cycle. Default value = 1. | :Optional. Double. The duty cycle. Default value = 1. | ||
== 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 probability of failure at time = 100.}} | {{APIComment|'Calculate the bounds on the model's probability of failure at time = 100.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
{{APIPrefix|Set}} ResultValue = AModel.Bounds_Unreliability(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 48: | ||
{{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 | |||
AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) | |||
{{APIComment|'Calculate the bounds on the model's probability of failure at time = 100.}} | {{APIComment|'Calculate the bounds on the model's probability of failure at time = 100.}} | ||
{{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues | |||
ResultValue = AModel.Bounds_Unreliability(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) |
Latest revision as of 19:02, 18 August 2016
Member of: SynthesisAPI.cModel
Calculates the bounds on the probability of failure at a specified time for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Remarks: 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_Unreliability( Time, StartAge, DutyCycle)
Parameters
Time
- Required. Double. The time at which to calculate the probability of failure.
StartAge
- Optional. Double. The start 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 probability of failure at time = 100. Dim ResultValue As BoundsValues Set ResultValue = AModel.Bounds_Unreliability(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) Set 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 probability of failure at time = 100. Dim ResultValue As BoundsValues ResultValue = AModel.Bounds_Unreliability(100) 'Output sample: Display the results for the upper and lower confidence bounds. MsgBox (" Upper bound: " & ResultValue.Upper & ", Lower bound: " & ResultValue.Lower)