CVariable Class: Difference between revisions

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


== Properties  ==
== Properties  ==
*'''[[cVariable.Name|Name]]''' {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
*Name (as ''string'') {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
*'''[[cVariable.ID|ID]]''' {{APIComment|Returns the ID of the resource (the one used in the repository).}}
*ID (as ''integer'') {{APIComment|Returns the ID of the resource (the one used in the repository).}}
*'''[[cVariable.ProjectID|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}}
*ProjectID (as ''integer'') {{APIComment|Returns the ID of the project the resource belongs to.}}
*'''[[cVariable.StartValue|StartValue]]''' {{APIComment|Sets or returns variable's start value.}}
*StartValue (as ''double'') {{APIComment|Sets or returns variable's start value.}}
*'''[[cVariable.ResetWhen|ResetWhen]]''' {{APIComment|Sets or returns when the variable gets reset.}}
*ResetWhen (as ''[[ResetOptionEnum Enumeration|ResetOptionEnum]]'') {{APIComment|Sets or returns when the variable gets reset.}}

Revision as of 17:02, 10 March 2014


Variables each store a fixed numerical value and can be programmatically varied during simulation.

Constructors

  • cVariable Creates a new variable resource.

Properties

  • Name (as string) Sets or returns the name of the model (the one used in the repository)
  • ID (as integer) Returns the ID of the resource (the one used in the repository).
  • ProjectID (as integer) Returns the ID of the project the resource belongs to.
  • StartValue (as double) Sets or returns variable's start value.
  • ResetWhen (as ResetOptionEnum) Sets or returns when the variable gets reset.