CVariable Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cVariable Class}}
{{DISPLAYTITLE:cVariable Class}}{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:APIClass|Global_Resources|Global Resources}}  


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


=== Constructors ===
<onlyinclude>Represents a variable resource.</onlyinclude>


*'''[[New cVariable]]''' {{APIComment|Creates a new instance of the resource.}}
==Constructors==
{| {{APITable}}
|-
| style="width: 180px;"|cVariable||Creates an instance of the cVariable class.
|-
|[[CVariable_Constructors|cVariable()]]||{{:CVariable_Constructors}}
|}


=== Properties  ===
 
*'''[[cVariable.Name|Name]]''' {{APIComment|Sets or returns the name of the model (the one used in the repository)}}
== Properties  ==
*'''[[cVariable.ID|ID]]''' {{APIComment|Returns the ID of the resource (the one used in the repository).}}
{| {{APITable}}
*'''[[cVariable.ProjectID|ProjectID]]''' {{APIComment|Returns the ID of the project the resource belongs to.}}
|-
*'''[[cVariable.StartValue|StartValue]]''' {{APIComment|Sets or returns variable's start value.}}
| style="width: 180px;"|ID||Gets the numeric ID of the variable. '''Integer'''.
*'''[[cVariable.ResetWhen|ResetWhen]]''' {{APIComment|Sets or returns when the variable gets reset.}}
|-
|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

APIWiki.png


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.



See Also

Retrieved from "https://www.reliawiki.com/index.php?title=CVariable_Class&oldid=65439"