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}}  
Sets confidence level for bounds calculations.
{{Template:CModel.SetConfindenceLevel.Cmt}}
== Method Syntax==
{{APIName|SetConfindenceLevel}}
{{APIName|(}}
{{APIPrefix|ByVal}}
{{APIName|Level}}
{{APIPrefix|As Double}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|Sides}}
{{APIPrefix|As}}
{{APIName|[[ConfBoundsSides]],}}
{{APIPrefix|ByVal}}
{{APIName|UseConfidenceLevelInPercents}}
{{APIPrefix|As Boolean,}}
{{APIPrefix|ByRef}}
{{APIName|sError}}
{{APIPrefix|As String}}
{{APIName|)}}
{{APIPrefix|As Boolean}}<br>
{{APIComment|Sets the confidence level for all subsequent confidence bounds calculations.}}


== Parameters ==
==Syntax==
'''Level'''
*SetConfindenceLevel( Level {{APIPrefix|As Double}} , Sides {{APIPrefix|As}} [[ConfBoundsSides Enumeration|ConfBoundsSides]] , UseConfidenceLevelInPercents {{APIPrefix|As Boolean}} , {{APIPrefix|sError}} {{APIPrefix|As String}} ) {{APIPrefix|As Boolean}}
{{APIComment|The confidence level.}}


'''Sides'''
Parameters
{{APIComment|The sides setting for this confidence level.}}
:''Level'': The confidence level.


'''UseConfidenceLevelInPercents'''
:''Sides'': The sides setting for this confidence level (e.g., lower bound), specified using the [[ConfBoundsSides Enumeration|ConfBoundsSides]] enumeration.
{{APIComment|Show result in percentages or decimal.}}


'''sError'''
:''UseConfidenceLevelInPercents'': Whether to show the result as a percentage (otherwise it is shown as a decimal).
{{APIComment|Return string for any error results.}}
 
:''sError'': Return string for any error results.


== Usage Example ==
== Usage Example ==

Revision as of 15:31, 7 March 2014


Sets the confidence level for all subsequent confidence bounds calculations. 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.
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)