ParamBoundsValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|cModel Class|cModel}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:ParamBoundsValues Class.Cmt}}
 
 
<onlyinclude>Represents the confidence bounds on the parameter estimates of an associated [[CModel_Class|cModel]] object.</onlyinclude>


== Properties  ==
== Properties  ==
*Upper (as ''double'') {{APIComment|Gets the upper bound.}}
{| {{APITable}}
*Lower (as ''double'') {{APIComment|Gets the lower bound.}}
|-
*ParamName (as ''string'') {{APIComment|Gets the parameter name.}}
| style="width: 170px;"|Upper||Gets the upper confidence bounds. '''Double'''.
|-
|Lower||Gets the lower confidence bounds. '''Double'''.
|-
|ParamName||Gets the parameter name. '''String'''.
|}
 
 
 
 


== Usage Example ==
==See Also==
In this usage example, the API is used to connect to a repository, retrieve one of the models in it and then get the lower confidence bound on a parameter in that model.
*[[CModel.Bounds Parameters|cModel.Bounds_Parameters Method]]
{{APIComment|'Declare a new repository connection class.}}
  Dim MyRepository As New Repository
 
{{APIComment|'Connect to a Synthesis repository.}}
  Dim Success As Boolean = False
  Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9")
 
{{APIComment|'Get a list of the names/IDs of projects in the connected repository.}}
  Dim ListOfProjects() As NameIdPair
  ListOfProjects = MyRepository.GetAllProjects
 
{{APIComment|'Open the first project in the list.}}
  MyRepository.SetCurrentProject(ListOfProjects(0).ID)
 
{{APIComment|'Get a list of the names/IDs of models in the current project.}}
  Dim ListOfModels() As NameIdPair
  ListOfModels = MyRepository.GetAllModelsInfo()
 
{{APIComment|'Retrieve the first model in the list.}}
  Dim AModel as cModel
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
{{APIComment|'Set the confidence level settings. See [[cModel.SetConfidenceLevel|SetConfidenceLevel]].}}
  Dim SuccessSetConfLevel As Boolean
  Dim SetsError As String
  SuccessSetConfLevel = AModel.SetCofidenceLevel(.9, ConfBoundsSides.TwoSidedBoth, False, SetsError)
 
{{APIComment|'Get the list of bounds on the model's parameters.}}
  Dim ListOfBounds as List(Of ParamBoundsValues)
  ListOfBounds = AModel.Bounds_Parameters()
 
{{APIComment|'Get the lower bound on the first parameter.}}
  Dim LowerBoundValue as Double
  LowerBoundValue = ListOfBounds(0).Lower

Latest revision as of 23:34, 7 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents the confidence bounds on the parameter estimates of an associated cModel object.

Properties

Name Description
Upper Gets the upper confidence bounds. Double.
Lower Gets the lower confidence bounds. Double.
ParamName Gets the parameter name. String.



See Also