CModel.SetConfidenceLevel: Difference between revisions

Latest revision as of 19:02, 9 June 2016

Sets the confidence level to use in confidence bounds calculations for published models. Returns a Boolean value; when true, indicates that a confidence level has been set.

Syntax

.SetConfidenceLevel(Level, Sides, UseConfidenceLevelInPercents, ByRef sError)

Parameters

Level

Required. Double. The confidence level, entered as a percentage.

Sides

Required. The sides setting (e.g., lower bound) for this confidence level. Can be any ConfBoundsSides constant.

UseConfidenceLevelInPercents

Required. Boolean. When true, the result is shown as a percentage; otherwise, it is shown as a decimal.

sError

Required. String. Returns a string for any error results.

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. 
 'Declare a string variable for any errors found during this method. 
  Dim ErrorMsg As String
  Call AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

 'Confidence bounds calculations are now possible. For example, 
 'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs. 
  Dim ResultValue As BoundsValues
  Set ResultValue = AModel.Bounds_Reliability(100)

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. 
 'Declare a string variable for any errors found during this method. 
  Dim ErrorMsg As String
  AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)

 'Confidence bounds calculations are now possible. For example, 
 'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs. 
  Dim ResultValue As BoundsValues
  ResultValue = AModel.Bounds_Reliability(100)

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:cModel.SetConfindenceLevel}}
+{{DISPLAYTITLE:cModel.SetConfidenceLevel}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
-{{Template:APIClass|CModel Class|cModel}}
-{{Template:CModel.SetConfindenceLevel.Cmt}} {{Template:BooleanReturn.Cmt}}
-==Syntax==
-*SetConfindenceLevel( Level {{APIPrefix|As Double}} , Sides {{APIPrefix|As}} [[ConfBoundsSides Enumeration|ConfBoundsSides]] , UseConfidenceLevelInPercents {{APIPrefix|As Boolean}} , {{APIPrefix|sError}} {{APIPrefix|As String}} ) {{APIPrefix|As Boolean}}
-Parameters
+<onlyinclude>Sets the confidence level to use in confidence bounds calculations for published models. Returns a '''Boolean''' value; when true, indicates that a confidence level has been set.</onlyinclude>
-:''Level'': The confidence level, entered as a percentage.
-:''Sides'': The sides setting for this confidence level (e.g., lower bound), specified using the [[ConfBoundsSides Enumeration|ConfBoundsSides]] enumeration.
+== Syntax ==
+ '''.SetConfidenceLevel'''(''Level'', ''Sides'', ''UseConfidenceLevelInPercents'', {{APIPrefix|ByRef}} ''sError'')
-:''UseConfidenceLevelInPercents'': Whether to show the result as a percentage (otherwise it is shown as a decimal).
+===Parameters===
+''Level''
+:Required. Double. The confidence level, entered as a percentage.
-:''sError'': Return string for any error results.
+''Sides''
+:Required. The sides setting (e.g., lower bound) for this confidence level. Can be any [[ConfBoundsSides Enumeration|ConfBoundsSides]] constant.
-== Usage Example ==
+''UseConfidenceLevelInPercents''
-{{APIComment|Declare the cModel class using an in-line parameter list.}}
+:Required. Boolean. When true, the result is shown as a percentage; otherwise, it is shown as a decimal.
-        Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "NewModel1", 1, 100)
-{{APIComment|Set a new confidence level. Set SetsError for any errors found during this method}}
+''sError''
-        Dim SuccessSetConfLevel As Boolean
+:Required. String. Returns a string for any error results.
-        Dim SetsError As String
-        SuccessSetConfLevel = newModel.SetConfindenceLevel(.9, [[ConfBoundsSides]].TwoSidedBoth, False, SetsError)
+== 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.}}
+ {{APIComment|'Declare a string variable for any errors found during this method.}}
+   {{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
+   {{APIPrefix|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)
+ {{APIComment|'Confidence bounds calculations are now possible. For example,}}
+ {{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}}
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
+   {{APIPrefix|Set}} ResultValue = AModel.Bounds_Reliability(100)
+ '''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|'Set the confidence level to 90% two-sided bounds.}}
+ {{APIComment|'Declare a string variable for any errors found during this method.}}
+   {{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
+   AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)
+ {{APIComment|'Confidence bounds calculations are now possible. For example,}}
+ {{APIComment|'the following code calculates the 90% two-sided confidence bounds on the reliability at 100 hrs.}}
+   {{APIPrefix|Dim}} ResultValue {{APIPrefix|As}} BoundsValues
+   ResultValue = AModel.Bounds_Reliability(100)

CModel.SetConfidenceLevel: Difference between revisions

Latest revision as of 19:02, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search