CVariable Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 8: Line 8:
== Properties  ==
== Properties  ==
*Name (as ''string'') {{APIComment|Sets or gets the name of the variable.}}
*Name (as ''string'') {{APIComment|Sets or gets the name of the variable.}}
*ID (as ''integer'') {{APIComment|Gets the ID of the variable.}}
*ID (as ''integer'') {{APIComment|Gets the numerical ID of the variable.}}
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the variable belongs to.}}
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the variable belongs to.}}
*StartValue (as ''double'') {{APIComment|Sets or gets the variable's initial value.}}
*StartValue (as ''double'') {{APIComment|Sets or gets the variable's initial value.}}
*ResetWhen (as ''[[ResetOptionEnum Enumeration|ResetOptionEnum]]'') {{APIComment|Sets or gets the enumeration that specifies when the variable's value gets reset.}}
*ResetWhen (as ''[[ResetOptionEnum Enumeration|ResetOptionEnum]]'') {{APIComment|Sets or gets the enumeration that specifies when the variable's value gets reset.}}

Revision as of 23:12, 11 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 gets the name of the variable.
  • ID (as integer) Gets the numerical ID of the variable.
  • ProjectID (as integer) Gets the numerical ID of the project the variable belongs to.
  • StartValue (as double) Sets or gets the variable's initial value.
  • ResetWhen (as ResetOptionEnum) Sets or gets the enumeration that specifies when the variable's value gets reset.