CModel.Bounds MeanTime: Difference between revisions

Latest revision as of 19:01, 18 August 2016

Calculates the bounds on the mean time to failure 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_MeanTime( CurrentAge, DutyCycle)

Parameters

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 mean time to failure. 
  Dim ResultValue As BoundsValues
  Set ResultValue = AModel.Bounds_MeanTime

 '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 mean time to failure. 
  Dim ResultValue As BoundsValues
  ResultValue = AModel.Bounds_MeanTime

 '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 MeanTime}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
-Returns the bounds of the mean time best fit. Requires the Confidence level to be set. See [[CModel.SetConfindenceLevel|SetConfindenceLevel]].
+<onlyinclude>Calculates the bounds on the mean time to failure for an associated cModel object. Returns a '''[[BoundsValues Class|BoundsValues]]''' object that represents the confidence bounds.</onlyinclude>
+{{Template:API_BoundsNote}}
 == Syntax==
-{{APIName|Bounds_MeanTime}}
+ '''.Bounds_MeanTime'''( ''CurrentAge'', ''DutyCycle'')
-{{APIName|(}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|CurrentAge}}
-{{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 mean time}}
-== Parameters ==
-'''CurrentAge'''
-{{APIComment|The current age.}}
-'''DutyCycle'''
+===Parameters===
-{{APIComment|The duty cycle.}}
+''CurrentAge''
+:Optional. Double. The current age. Default value = 0.
-== Usage Example ==
+''DutyCycle''
-{{APIComment|Declare a new repository connection class.}}
+:Optional. Double. The duty cycle. Default value = 1.
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
-        Dim Success As Boolean = False
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Get the list of Projects in the connected repository.}}
+== Example ==
-        Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
+This example assumes that a published model with ID #47 exists in the repository.
-        ListOfModels = MyRepository.GetAllModelsInfo()
-{{APIComment|Select the ID of the model and retrieve it.}}
+ '''VBA'''
-        Dim AModel as cModel
-        AModel = MyRepository.GetModel(ListOfModels(0).ID)
+ {{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 mean time to failure.}}
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
+   {{APIPrefix|Set}} ResultValue = AModel.Bounds_MeanTime
+ {{APIComment|'Output sample: Display the results for the upper and lower confidence bounds.}}
+   MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower)
-{{APIComment|Get the Bounds on the meantime.}}
+ '''VB.NET'''
-        Dim ModelBoundsValue as BoundsValues
-        ModelBoundsValue = AModel.Bounds_MeanTime()
+ {{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.}}
+   {{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
+   AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
+ {{APIComment|'Calculate the bounds on the model's mean time to failure.}}
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
+   ResultValue = AModel.Bounds_MeanTime
+ {{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 MeanTime: Difference between revisions

Latest revision as of 19:01, 18 August 2016

Syntax

Parameters

Example

Navigation menu

Search