CModel.SetConfidenceLevel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cModel.SetConfindenceLevel}}
{{DISPLAYTITLE:cModel.SetConfindenceLevel}}
{{Template:APIClass|CModel Class|cModel}}  
{{Template:APIClass|CModel Class|cModel}}  
{{Template:CModel.SetConfindenceLevel.Cmt}}
{{Template:CModel.SetConfindenceLevel.Cmt}} {{Template:BooleanReturn.Cmt}}


==Syntax==
==Syntax==
Line 7: Line 7:


Parameters
Parameters
:''Level'': The confidence level.
:''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.
:''Sides'': The sides setting for this confidence level (e.g., lower bound), specified using the [[ConfBoundsSides Enumeration|ConfBoundsSides]] enumeration.

Revision as of 15:32, 7 March 2014


Sets the confidence level for all subsequent confidence bounds calculations. Returns True if successful, otherwise returns False. Returns True if successful, otherwise returns False.

Syntax

  • SetConfindenceLevel( Level As Double , Sides As ConfBoundsSides , UseConfidenceLevelInPercents As Boolean , sError As String ) As Boolean

Parameters

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.
UseConfidenceLevelInPercents: Whether to show the result as a percentage (otherwise it is shown as a decimal).
sError: Return string for any error results.

Usage Example

Declare the cModel class using an in-line parameter list.

       Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "NewModel1", 1, 100)

Set a new confidence level. Set SetsError for any errors found during this method

       Dim SuccessSetConfLevel As Boolean
       Dim SetsError As String
       SuccessSetConfLevel = newModel.SetConfindenceLevel(.9, ConfBoundsSides.TwoSidedBoth, False, SetsError)