CVariable Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cVariable Class}}
{{DISPLAYTITLE:cVariable Class}}{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:APIClass|Resource Classes|Resource Classes}}  
{{CVariable Class.Cmt}}




{{Template:ResourceLinkToRepositoryClass.Cmt}}
<onlyinclude>Represents a variable resource.</onlyinclude>
== Constructors ==
 
*cVariable {{APIComment|Creates a new variable resource.}}
==Constructors==
{| {{APITable}}
|-
| style="width: 180px;"|cVariable||Creates an instance of the cVariable class.
|-
|[[CVariable_Constructors|cVariable()]]||{{:CVariable_Constructors}}
|}
 


== Properties  ==
== Properties  ==
*Name (as ''string'') {{APIComment|Gets or sets the name of the variable.}}
{| {{APITable}}
*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.}}
| style="width: 180px;"|ID||Gets the numeric ID of the variable. '''Integer'''.
*StartValue (as ''double'') {{APIComment|Gets or sets the variable's Initial Value.}}
|-
*ResetWhen (as ''[[ResetOptionEnum Enumeration|ResetOptionEnum]]'') {{APIComment|Gets or sets the enumeration that specifies when the variable's value 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'''.
|}
 
 
 


== Methods ==


'''Set/Return Item Properties'''
==See Also==
*[[cVariable.ItemCategoryID|ItemCategoryID(Integer)]] {{APIComment|{{Template:ItemCategoryID.Cmt}}}}
*[[Repository.Variable.AddVariable|Repository.Variable.AddVariable Method]]
*[[cVariable.ItemPartNumber|ItemPartNumber(String)]] {{APIComment|{{Template:ItemPartNumber.Cmt}}}}
*[[Repository.Variable.GetAllVariables|Repository.Variable.GetAllVariables Method]]
*[[cVariable.ItemVersion|ItemVersion(String)]] {{APIComment|{{Template:ItemVersion.Cmt}}}}
*[[Repository.Variable.GetVariable|Repository.Variable.GetVariable Method]]
*[[cVariable.ItemSupplier|ItemSupplier(String)]] {{APIComment|{{Template:ItemSupplier.Cmt}}}}
*[[Repository.Variable.UpdateVariable|Repository.Variable.UpdateVariable Method]]
*[[cVariable.ItemApplication|ItemApplication(String)]] {{APIComment|{{Template:ItemApplication.Cmt}}}}
*[[cVariable.ItemDescription|ItemDescription(String)]] {{APIComment|{{Template:ItemDescription.Cmt}}}}
*[[cVariable.ItemComments|ItemComments(String)]] {{APIComment|{{Template:ItemComments.Cmt}}}}
*[[cVariable.ItemKeywords|ItemKeywords(String)]] {{APIComment|{{Template:ItemKeywords.Cmt}}}}

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"