CVariable Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) |
No edit summary |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:cVariable Class}} | {{DISPLAYTITLE:cVariable Class}}{{Template:API}}{{Template:APIBreadcrumb}} | ||
{{Template: | |||
{{ | |||
<onlyinclude>Represents a variable resource.</onlyinclude> | |||
==Constructors== | |||
{| {{APITable}} | |||
|- | |||
| style="width: 180px;"|cVariable||Creates an instance of the cVariable class. | |||
|- | |||
|[[CVariable_Constructors|cVariable()]]||{{:CVariable_Constructors}} | |||
|} | |||
== Properties == | == Properties == | ||
{| {{APITable}} | |||
|- | |||
| style="width: 180px;"|ID||Gets the numeric ID of the variable. '''Integer'''. | |||
|- | |||
|ItemCategoryID||Gets or sets the category ID. (Synthesis identifier) '''Integer''' | |||
|- | |||
|ItemComments||Gets or sets the comments. (Synthesis identifier) '''String''' | |||
|- | |||
|Name||Gets or sets the name of the variable. '''String'''. | |||
|- | |||
|ProjectID||Gets the numeric ID of the project the variable belongs to. '''Integer'''. | |||
|- | |||
|ResetWhen||Gets or sets a value from the '''[[ResetOptionEnum Enumeration|ResetOptionEnum]]''' enumeration, which specifies whether the variable will retain its value during simulation or be reset to its initial value at specific times. Default value = 1 (reset after each set of runs). | |||
|- | |||
|StartValue||Gets or sets the variable's initial value. '''Double'''. | |||
|} | |||
==See Also== | |||
*[[Repository.Variable.AddVariable|Repository.Variable.AddVariable Method]] | |||
*[[Repository.Variable.GetAllVariables|Repository.Variable.GetAllVariables Method]] | |||
*[[Repository.Variable.GetVariable|Repository.Variable.GetVariable Method]] | |||
*[[Repository.Variable.UpdateVariable|Repository.Variable.UpdateVariable Method]] | |||
Latest revision as of 17:46, 12 March 2019
 |
Member of: SynthesisAPI
Represents a variable resource.
Constructors
| Name | Description |
|---|---|
| cVariable | Creates an instance of the cVariable class. |
| cVariable() | A parameterized constructor for the cVariable class. (.NET only) |
Properties
| Name | Description |
|---|---|
| ID | Gets the numeric ID of the variable. Integer. |
| ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
| ItemComments | Gets or sets the comments. (Synthesis identifier) String |
| Name | Gets or sets the name of the variable. String. |
| ProjectID | Gets the numeric ID of the project the variable belongs to. Integer. |
| ResetWhen | Gets or sets a value from the ResetOptionEnum enumeration, which specifies whether the variable will retain its value during simulation or be reset to its initial value at specific times. Default value = 1 (reset after each set of runs). |
| StartValue | Gets or sets the variable's initial value. Double. |