ParamValues Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|cMode Class|cModel}}
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:ParamValues Class.Cmt}}


== Properties  ==
*Value (as ''double'')    {{APIComment|Gets the value of the parameter.}}
*ParamName (as ''string'') {{APIComment|Gets the name of the parameter.}}


== Usage Example ==
<onlyinclude>Represents the parameter name and value pair of a [[CModel_Class|cModel]] object.</onlyinclude>
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
== Properties  ==
        Dim Success As Boolean = False
{| {{APITable}}
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
|-
| style="width: 150px;"|Value||Gets the value of the parameter. '''Double'''.
|-
|ParamName||Gets the name of the parameter.'''String'''.
|}


{{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).ParamName


{{APIComment|Get the value of the model's first parameter.}}
==See Also==
        Dim ModelParamValue as Double
*[[cModel.Parameters|cModel.Parameters Method]]
        ModelParamValue = ModelParameters(0).Value

Latest revision as of 17:51, 17 June 2016

APIWiki.png


Member of: SynthesisAPI


Represents the parameter name and value pair of a cModel object.

Properties

Name Description
Value Gets the value of the parameter. Double.
ParamName Gets the name of the parameter.String.



See Also