CModel.Bounds Reliability: Difference between revisions

Latest revision as of 16:03, 23 September 2016

Calculates the bounds on the reliability at the 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_Reliability( Time, StartAge, DutyCycle)

Parameters

Time

Required. Double. The time at which to calculate the reliability.

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 reliability at time = 100. 
  Dim ResultValue As BoundsValues
  Set ResultValue = AModel.Bounds_Reliability(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 reliability at time = 100. 
  Dim ResultValue As BoundsValues
  ResultValue = AModel.Bounds_Reliability(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: @@
-{{DISPLAYTITLE:cModel.Bounds_Reliability}}
+{{DISPLAYTITLE:cModel.Bounds Reliability}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
-{{Template:APIClass|CModel Class|cModel}}
-{{Template:CModel.Bounds Reliability.Cmt}} {{Template:CModel.BoundsNote.Cmt}}
+<onlyinclude>Calculates the bounds on the reliability at the specified time for an associated cModel object. Returns a '''[[BoundsValues Class|BoundsValues]]''' object that represents the confidence bounds.</onlyinclude>
+{{Template:API_BoundsNote}}
 == Syntax==
+ '''.Bounds_Reliability'''( ''Time'', ''StartAge'', ''DutyCycle'')
+===Parameters===
+''Time''
+:Required. Double. The time at which to calculate the reliability.
-*Bounds_Reliability( Time {{APIPrefix|As Double}} , {{APIPrefix|Optional}} StartAge {{APIPrefix|As Double}} = 0 , {{APIPrefix|Optional}} DutyCycle {{APIPrefix|As Double}} = 1.0 ) {{APIPrefix|As}} [[BoundsValues Class|BoundsValues]]
+''StartAge''
+:Optional. Double. The start age. Default value = 0.
-Parameters
+''DutyCycle''
-:''Time'': The time at which to calculate the reliability.
+:Optional. Double. The duty cycle. Default value = 1.
-:''StartAge'': The start age.
-:''DutyCycle'': The duty cycle.
+== Example ==
+This example assumes that a published model with ID #47 exists in the repository.
-== Usage Example ==
+ '''VBA'''
-  {{APIComment|'Declare a new repository connection object. See [[Repository Class|Repository]].}}
-  Dim MyRepository As New Repository
+ {{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|'Connect to the Synthesis repository.}}
+  {{APIComment|'Set the confidence level to 90% two-sided bounds.}}
-  Dim Success As Boolean = False
+   {{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+   {{APIPrefix|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)
-  {{APIComment|'Get the list of Projects in the connected repository.}}
+  {{APIComment|'Calculate the bounds on the model's reliability at time &#61; 100.}}
-  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
-  ListOfModels = MyRepository.GetAllModelsInfo()
+   {{APIPrefix|Set}} ResultValue = AModel.Bounds_Reliability(100)
-  {{APIComment|'Select the ID of the model and retrieve it.}}
+  {{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}}
-  Dim AModel as cModel
+   MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower)
-  AModel = MyRepository.GetModel(ListOfModels(0).ID)
+ '''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)
+   AModel = MyRepository.Model.GetModel(47)
-  {{APIComment|'Get the bounds on reliability at time &#61; 100.}}
+  {{APIComment|'Set the confidence level to 90% two-sided bounds.}}
-  Dim ModelBoundsValue as BoundsValues
+   {{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
-  ModelBoundsValue = AModel.Bounds_Reliability(100)
+   AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
+ {{APIComment|'Calculate the bounds on the model's reliability at time &#61; 100.}}
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
+   ResultValue = AModel.Bounds_Reliability(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 Reliability: Difference between revisions

Latest revision as of 16:03, 23 September 2016

Syntax

Parameters

Example

Navigation menu

Search