CModel.Bounds Reliability: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "CModel.Bounds Reliability" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
mNo edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|CModel Class|CModel}}  
{{DISPLAYTITLE:cModel.Bounds Reliability}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
Returns the bonds on the reliability.  Requires the Confidence level to be set. See [[CModel.SetConfindenceLevel|SetConfindenceLevel]].
 
== Syntax==
 
<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>
 


{{APIName|Bounds_Reliability}}
{{Template:API_BoundsNote}}
{{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 reliability given time.}}


== Parameters ==
== Syntax==
'''Time'''
'''.Bounds_Reliability'''( ''Time'', ''StartAge'', ''DutyCycle'')
{{APIComment|The time to calculate the reliability.}}


'''StartAge'''
===Parameters===
{{APIComment|The start age.}}
''Time''
:Required. Double. The time at which to calculate the reliability.


'''DutyCycle'''
''StartAge''
{{APIComment|The duty cycle.}}
:Optional. Double. The start 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 reliability at time &#61; 100.}}
  {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
  {{APIPrefix|Set}} 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)


{{APIComment|Get the Bounds on reliability.}}
'''VB.NET'''
        Dim ModelBoundsValue as BoundsValues
        ModelBoundsValue = AModel.Bounds_Reliability(100)
{{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 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)

Latest revision as of 16:03, 23 September 2016

APIWiki.png


Member of: SynthesisAPI.cModel


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)
Retrieved from "https://www.reliawiki.com/index.php?title=CModel.Bounds_Reliability&oldid=64748"