ParamValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


== Properties  ==
== Properties  ==
*'''[[ParamValues.Value|Value]]''' {{APIComment|Gets the value of the parameter given the ID}}
*Value (as ''double'')    {{APIComment|Gets the value of the parameter.}}
*'''[[ParamValues.ParamName|ParamName]]''' {{APIComment|Gets the name of the parameter}}
*ParamName (as ''string'') {{APIComment|Gets the name of the parameter.}}
 
== 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 Model Parameters.}}
        Dim ModelParameters() As ParamValues
        ModelParameters = AModel.Parameters
 
{{APIComment|Get the name of the model's first parameter.}}
        Dim ModelParamName as String
        ModelParamVame = ModelParameters(0).Name
 
{{APIComment|Get the value of the model's first parameter.}}
        Dim ModelParamValue as Double
        ModelParamValue = ModelParameters(0).Value

Revision as of 17:09, 6 March 2014


Model's parameter name and value.

Properties

  • Value (as double) Gets the value of the parameter.
  • ParamName (as string) Gets the name of the parameter.

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 Model Parameters.

       Dim ModelParameters() As ParamValues
       ModelParameters = AModel.Parameters

Get the name of the model's first parameter.

       Dim ModelParamName as String
       ModelParamVame = ModelParameters(0).Name

Get the value of the model's first parameter.

       Dim ModelParamValue as Double
       ModelParamValue = ModelParameters(0).Value