ParamBoundsValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 7: Line 7:
*ParamName (as ''String'') {{APIComment|Returns the parameter name}}
*ParamName (as ''String'') {{APIComment|Returns the parameter name}}


== Formatted Usage Example ==
== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
  {{APIComment|'Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository
  Private WithEvents MyRepository As New Repository
 
 
{{APIComment|Connect to the Synthesis repository.}}
{{APIComment|'Connect to the Synthesis repository.}}
        Dim Success As Boolean = False
  Dim Success As Boolean = False
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
{{APIComment|Get the list of Projects in the connected repository.}}
{{APIComment|'Get the list of Projects in the connected repository.}}
        Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
        ListOfModels = MyRepository.GetAllModelsInfo()
  ListOfModels = MyRepository.GetAllModelsInfo()
 
 
{{APIComment|Select the ID of the model and retrieve it.}}
{{APIComment|'Select the ID of the model and retrieve it.}}
        Dim AModel as cModel
  Dim AModel as cModel
        AModel = MyRepository.GetModel(ListOfModels(0).ID)
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
 
{{APIComment|Get the list of parameter bounds.}}
{{APIComment|'Get the list of parameter bounds.}}
        Dim ListOfBounds as List(Of ParamBoundsValues)
  Dim ListOfBounds as List(Of ParamBoundsValues)
        ListOfBounds = AModel.Bounds_Parameters()
  ListOfBounds = AModel.Bounds_Parameters()
 
 
{{APIComment|Get the Lower Bound result. In this example, from the first parameter.}}
{{APIComment|'Get the Lower Bound result. In this example, from the first parameter.}}
        Dim LowerBoundValue as Double
  Dim LowerBoundValue as Double
        LowerBoundValue = ListOfBounds(0).Lower
  LowerBoundValue = ListOfBounds(0).Lower

Revision as of 23:54, 11 April 2014


Stores the confidence bounds on the model parameters. Use the SetConfidenceLevel method to specify the confidence bound settings.

Properties

  • Upper (as Double) Returns the upper value
  • Lower (as Double) Returns the lower value
  • ParamName (as String) Returns the parameter name

Usage Example

  'Declare a new repository connection class. 
 Private WithEvents MyRepository As New Repository
 
 'Connect to the Synthesis repository. 
 Dim Success As Boolean = False
 Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 'Get the list of Projects in the connected repository. 
 Dim ListOfModels() As NameIdPair
 ListOfModels = MyRepository.GetAllModelsInfo()
 
 'Select the ID of the model and retrieve it. 
 Dim AModel as cModel
 AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
 'Get the list of parameter bounds. 
  Dim ListOfBounds as List(Of ParamBoundsValues)
  ListOfBounds = AModel.Bounds_Parameters()
 
 'Get the Lower Bound result. In this example, from the first parameter. 
 Dim LowerBoundValue as Double
 LowerBoundValue = ListOfBounds(0).Lower