CVariable Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) |
||
| Line 16: | Line 16: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
| style="width: 180px;"| | | style="width: 180px;"|ID||Gets the numeric ID of the variable. '''Integer'''. | ||
|- | |- | ||
| | |{{Template:API_TxtIdentifiers}} | ||
|- | |||
|Name||Gets or sets the name of the variable. '''String'''. | |||
|- | |- | ||
|ProjectID||Gets the numeric ID of the project the variable belongs to. '''Integer'''. | |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. | |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. | ||
|- | |- | ||
| | |StartValue||Gets or sets the variable's initial value. '''Double'''. | ||
|} | |} | ||
Revision as of 20:24, 31 August 2015
 |
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. |
| ItemApplication | Gets or sets the item's application. (Synthesis identifier) String |
| ItemCategoryID | Gets or sets the category ID. (Synthesis identifier) Integer |
| ItemComments | Gets or sets the comments. (Synthesis identifier) String |
| ItemDescription | Gets or sets the description. (Synthesis identifier) String |
| ItemKeywords | Gets or sets the keywords. (Synthesis identifier) String |
| ItemPartNumber | Gets or sets the part number. (Synthesis identifier) String |
| ItemSupplier | Gets or sets the supplier name. (Synthesis identifier) String |
| ItemVersion | Gets or sets the version number. (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. |
| StartValue | Gets or sets the variable's initial value. Double. |