ParamBoundsValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Model|Global Model}}
{{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|Returns the upper value}}
{| {{APITable}}
*Lower (as ''double'') {{APIComment|Returns the lower value}}
|-
*ParamName (as ''string'') {{APIComment|Returns 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==
{{APIComment|'Declare a new repository connection class.}}
*[[CModel.Bounds Parameters|cModel.Bounds_Parameters Method]]
  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.}}
  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
  ListOfModels = MyRepository.GetAllModelsInfo()
 
{{APIComment|'Select the ID of the model and retrieve it.}}
  Dim AModel as cModel
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
{{APIComment|'Get the list of parameter bounds.}}
  Dim ListOfBounds as List(Of ParamBoundsValues)
  ListOfBounds = AModel.Bounds_Parameters()
 
{{APIComment|'Get the Lower Bound result. In this example, from 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