CModel.Parameters: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cModel.Parameters}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[CModel Class|cModel]]}}
{{DISPLAYTITLE:cModel.Parameters}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}




<onlyinclude>Returns a '''[[ParamValues Class|ParamValues]]''' object array, which contains the names and values of a model's parameters.</onlyinclude>
<onlyinclude>Returns an array of '''[[ParamValues Class|ParamValues]]''' objects that represent the parameter name and value pairs of an associated cModel object.</onlyinclude>


== Syntax==
== Syntax==
Line 17: Line 17:
  {{APIComment|...}}
  {{APIComment|...}}
   
   
  {{APIComment|'Get a list of the model's parameters.}}
  {{APIComment|'Get an array of the model's parameters.}}
   {{APIPrefix|Dim}} ModelParameters() {{APIPrefix|As}} ParamValues
   {{APIPrefix|Dim}} ModelParameters() {{APIPrefix|As}} ParamValues
   ModelParameters = AModel.Parameters
   ModelParameters = AModel.Parameters()
{{APIComment|'Output example: Display the name and value of the first parameter.}}
  Dim ParamName {{APIPrefix|As}} String
  Dim ParamValue {{APIPrefix|As}} Double
  ParamName = ModelParameters(0).ParamName
  ParamValue = ModelParameters(0).Value
  MsgBox (ParamName & " = " & ParamValue)

Latest revision as of 17:53, 17 June 2016

APIWiki.png


Member of: SynthesisAPI.cModel


Returns an array of ParamValues objects that represent the parameter name and value pairs of an associated cModel object.

Syntax

.Parameters()


Example

VBA|VB.NET

 ... 

 'Add code to get an existing model or create a new one. 
 Dim AModel As New cModel
 ... 

 'Get an array of the model's parameters. 
 Dim ModelParameters() As ParamValues
 ModelParameters = AModel.Parameters()

 'Output example: Display the name and value of the first parameter. 
 Dim ParamName As String
 Dim ParamValue As Double
 ParamName = ModelParameters(0).ParamName
 ParamValue = ModelParameters(0).Value
 MsgBox (ParamName & " = " & ParamValue)