|
|
| Line 1: |
Line 1: |
| {{Template:APIClass|cModel Class|cModel}} | | {{Template:API}}{{Template:APIBreadcrumb|9|.[[CModel Class|cModel]]}} |
| {{Template:ParamBoundsValues Class.Cmt}} | | |
| | |
| | <onlyinclude>Stores the confidence bounds on a model's parameter estimates.</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||''Double''. The upper bound. |
| | | |- |
| == Usage Example ==
| | |Lower||''Double''. The lower bound. |
| 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.
| | |- |
| {{APIComment|'Declare a new repository connection object.}}
| | |ParamName||''String''. The parameter name. |
| 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
| |
|
| |
| {{APIComment|'Disconnect from the repository.}}
| |
| MyRepository.DisconnectFromRepository
| |
