CModel.Bounds FailureRate: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cModel.Bounds_FailureRate}}
{{DISPLAYTITLE:cModel.Bounds FailureRate}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[CModel Class|cModel]]}}
{{Template:APIClass|CModel Class|cModel}}  
 
{{Template:CModel.Bounds FailureRate.Cmt}} {{Template:CModel.BoundsNote.Cmt}}
 
<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.  


== Syntax==
== Syntax==
*Bounds_FailureRate( Time {{APIPrefix|As Double}} , {{APIPrefix|Optional}} CurrentAge {{APIPrefix|As Double}} = 0 , {{APIPrefix|Optional}} DutyCycle {{APIPrefix|As Double}} = 1.0 ) {{APIPrefix|As}} [[BoundsValues Class|BoundsValues]]
'''.Bounds_FailureRate'''( ''Time'', ''CurrentAge'', ''DutyCycle'')  


Parameters  
===Parameters===
:''Time'': The time to calculate the failure rate.
''Time''
:Double. The time at which to calculate the failure rate. (Required)


:''CurrentAge'': The current age.
''CurrentAge''
:Double. The current age. Default value = 0. (Optional)


:''DutyCycle'': The duty cycle.
''DutyCycle''
:Double. The duty cycle. Default value = 1. (Optional)


== Usage Example ==
 
  {{APIComment|'Declare a new repository connection object. See [[Repository Class|Repository]].}}
== Example ==
  Private WithEvents MyRepository As New Repository
'''VBA'''
{{APIComment|...}}
  {{APIComment|'Add code to get an existing model or create a new one.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
{{APIComment|...}}
    
    
  {{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. See [[NameIdPair Class|NameIdPair]].}}
  {{APIComment|'Calculate the bounds on the model's failure rate at time &#61; 100.}}
   Dim ListOfModels() As NameIdPair
   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
   ListOfModels = MyRepository.GetAllModelsInfo()
   {{APIPrefix|Set}} ResultValue = AModel.Bounds_FailureRate(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|'Add code to get an existing model or create a new one.}}
   {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
{{APIComment|...}}
    
    
  {{APIComment|'Get the Bounds on the failure rate 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_FailureRate(100)
  AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
{{APIComment|'Calculate the bounds on the model's failure rate at time &#61; 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.}}
  MsgBox ({{APIString|" Upper bound: "}} & ResultValue.Upper & {{APIString|", Lower bound: "}} & ResultValue.Lower)

Revision as of 20:20, 29 July 2015

APIWiki.png


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.

Syntax

.Bounds_FailureRate( Time, CurrentAge, DutyCycle)

Parameters

Time

Double. The time at which to calculate the failure rate. (Required)

CurrentAge

Double. The current age. Default value = 0. (Optional)

DutyCycle

Double. The duty cycle. Default value = 1. (Optional)


Example

VBA

 ... 

 'Add code to get an existing model or create a new one. 
 Dim AModel As New cModel
 ... 
 
 'Set the confidence level to 90% two-sided bounds. 
 Dim ErrorMsg As String
 CallAModel.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

 ... 

 'Add code to get an existing model or create a new one. 
 Dim AModel As New cModel
 ... 
 
 '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)
Retrieved from "https://www.reliawiki.com/index.php?title=CModel.Bounds_FailureRate&oldid=60117"