ParamValues Class: Difference between revisions

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


== Usage Example ==
== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository
  Dim 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 Model Parameters.}}
{{APIComment|Get the list of Model Parameters.}}
        Dim ModelParameters() As ParamValues
  Dim ModelParameters() As ParamValues
        ModelParameters = AModel.Parameters
  ModelParameters = AModel.Parameters
 
 
{{APIComment|Get the name of the model's first parameter.}}
{{APIComment|Get the name of the model's first parameter.}}
        Dim ModelParamName as String
  Dim ModelParamName as String
        ModelParamVame = ModelParameters(0).ParamName
  ModelParamVame = ModelParameters(0).ParamName
 
 
{{APIComment|Get the value of the model's first parameter.}}
{{APIComment|Get the value of the model's first parameter.}}
        Dim ModelParamValue as Double
  Dim ModelParamValue as Double
        ModelParamValue = ModelParameters(0).Value
  ModelParamValue = ModelParameters(0).Value

Revision as of 22:15, 17 April 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. 
 Dim 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).ParamName
 
 Get the value of the model's first parameter. 
 Dim ModelParamValue as Double
 ModelParamValue = ModelParameters(0).Value