CModel.Bounds Unreliability: Difference between revisions

Latest revision as of 19:02, 18 August 2016

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|CModel Class|CModel}}
+{{DISPLAYTITLE:cModel.Bounds Unreliability}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
-Returns bounds on the unreliability. Requires the Confidence level to be set. See [[CModel.SetConfindenceLevel|SetConfindenceLevel]].
-== Declaration  ==
-{{APIName|Bounds_Unreliability}}
-{{APIName|(}}
-{{APIPrefix|ByVal}}
-{{APIName|Time}}
-{{APIPrefix|As Double}}
-{{APIName|,}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|StartAge}}
-{{APIPrefix|As Double}}
-=
-{{APIName|0,}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|DutyCycle}}
-{{APIPrefix|As Double}}
-=
-{{APIName|1.0)}}
-{{APIPrefix|As}}
-{{APIName|[[BoundsValues Class|BoundsValues]]}}<br>
-{{APIComment|Returns the bounds on the unreliability given time}}
-== Parameters ==
-'''Time'''
-{{APIComment|The time to calculate the reliability.}}
-'''StartAge'''
+<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>
-{{APIComment|The start age.}}
-'''DutyCycle'''
-{{APIComment|The duty cycle.}}
-== Usage Example ==
+{{Template:API_BoundsNote}}
-{{APIComment|Declare a new repository connection class.}}
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
+== Syntax==
-        Dim Success As Boolean = False
+ '''.Bounds_Unreliability'''( ''Time'', ''StartAge'', ''DutyCycle'')
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Get the list of Projects in the connected repository.}}
+===Parameters===
-        Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
+''Time''
-        ListOfModels = MyRepository.GetAllModelsInfo()
+:Required. Double. The time at which to calculate the probability of failure.
-{{APIComment|Select the ID of the model and retrieve it.}}
+''StartAge''
-        Dim AModel as cModel
+:Optional. Double. The start age. Default value = 0.
-        AModel = MyRepository.GetModel(ListOfModels(0).ID)
-{{APIComment|Get the Bounds on unreliability.}}
+''DutyCycle''
-        Dim ModelBoundsValue as BoundsValues
+:Optional. Double. The duty cycle. Default value = 1.
-        ModelBoundsValue = AModel.Bounds_Unreliability(100)
+== Example ==
+This example assumes that a published model with ID #47 exists in the repository.
+ '''VBA'''
+ {{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.}}
+   {{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 &#61; 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.}}
+   MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower)
+ '''VB.NET'''
+ {{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.}}
+   {{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 &#61; 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.}}
+   MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower)

CModel.Bounds Unreliability: Difference between revisions

Latest revision as of 19:02, 18 August 2016

Syntax

Parameters

Example

Navigation menu

Search