ParamBoundsValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
*'''[[ParamBoundsValues.Lower|Lower]]''' {{APIComment|Returns the lower value}}
*'''[[ParamBoundsValues.Lower|Lower]]''' {{APIComment|Returns the lower value}}
*'''[[ParamBoundsValues.ParamName|ParamName]]''' {{APIComment|Returns the parameter name}}
*'''[[ParamBoundsValues.ParamName|ParamName]]''' {{APIComment|Returns the parameter name}}
== Formatted Usage Example ==
{{APIComment|Declare a new repository connection class.}}
        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

Revision as of 20:50, 6 February 2014


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

Properties

  • Upper Returns the upper value
  • Lower Returns the lower value
  • ParamName Returns the parameter name

Formatted 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