CVariable Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cVariable Class}}
{{InProgress}}{{DISPLAYTITLE:cVariable Class}}{{Template:API}}{{Template:APIBreadcrumbClass}}
{{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;"|Name||Gets or sets the name of the variable. '''String'''.
*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.}}
|ID||Gets the numeric ID of the variable. '''Integer'''.
|-
|ProjectID||Gets the numeric ID of the project the variable belongs to. '''Integer'''.
|-
|StartValue||Gets or sets the variable's initial value. '''Double'''.
|-
|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.
|}


== Methods ==


'''Set/Return Item Properties'''
'''Synthesis Identifiers'''
*[[cVariable.ItemCategoryID|ItemCategoryID(Integer)]] {{APIComment|{{Template:ItemCategoryID.Cmt}}}}
{| {{APITable}}
*[[cVariable.ItemPartNumber|ItemPartNumber(String)]] {{APIComment|{{Template:ItemPartNumber.Cmt}}}}
|-
*[[cVariable.ItemVersion|ItemVersion(String)]] {{APIComment|{{Template:ItemVersion.Cmt}}}}
| style="width: 180px;"|{{Template:API_TxtIdentifiers}}
*[[cVariable.ItemSupplier|ItemSupplier(String)]] {{APIComment|{{Template:ItemSupplier.Cmt}}}}
|}
*[[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}}}}

Revision as of 22:48, 11 August 2015

Template:InProgress

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
Name Gets or sets the name of the variable. String.
ID Gets the numeric ID of the variable. Integer.
ProjectID Gets the numeric ID of the project the variable belongs to. Integer.
StartValue Gets or sets the variable's initial value. Double.
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.


Synthesis Identifiers

Name Description
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
Retrieved from "https://www.reliawiki.com/index.php?title=CVariable_Class&oldid=60372"