ModelCenter APIs 2025 R1

Variable

Last update: 16.07.2025

public class Variable : PHXCOMObject

This is a base class for variable types in ModelCenter

Author

Woyak, 9/2001

Inheritors
Array
BooleanVariable
DoubleVariable
FileVariable
GeometryVariable
IntegerVariable
ObjectVariable
ReferenceVariable
StringVariable
Array
BooleanVariable
DoubleVariable
FileVariable
GeometryVariable
IntegerVariable
ObjectVariable
ReferenceVariable
StringVariable

Types

Name Summary
MetadataAccess enum MetadataAccess
Supported access levels.
MetadataType enum MetadataType
Supported metadata types.

Functions

Name Summary
dependentLinks public dependentLinks(): VariableLinks
Returns a list of links that immediately depend on the value of this variable.
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
fromString public fromString(str: String)
Sets the value for the variable from a string.
getDirectDependents public getDirectDependents(): Variables
public getDirectDependents(followSuspended: Boolean): Variables
Gets all the immediately linked outputs of this variable.
getDirectPrecedents public getDirectPrecedents(): Variables
public getDirectPrecedents(followSuspended: Boolean): Variables
Gets all the immediately linked inputs of this variable.
getFullName public getFullName(): String
Gets the full name of the variable, e.g.
getHasChanged public getHasChanged(): Boolean
Boolean which indicates if the variable has changed since the last time the boolean was reset.
getHide public getHide(): Boolean
Gets whether the variable is hidden or not
getMetadata public getMetadata(name: String): Variant
Get a metadata value.
getName public getName(): String
Gets the name of the variable, e.g.
getOwningComponent public getOwningComponent(): Component
Get the component which owns this variable.
getType public getType(): String
Gets the type of the variable.
invalidate public invalidate()
Invalidates the variable
isInput public isInput(): Boolean
Indicates whether the variable is an input or output
isInputToComponent public isInputToComponent(): Boolean
Indicates whether a variable is an input to a component
isInputToModel public isInputToModel(): Boolean
Indicates whether a variable is an input to the Model
isValid public isValid(): Boolean
Indicates whether the variable is currently valid or not
precedentLinks public precedentLinks(): VariableLinks
Returns a list of links that are immediate precedents to the value of this variable.
release public release()
Releases the COM reference to ModelCenter for this object.
releaseObjects public releaseObjects()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them.
setHasChanged public setHasChanged(flag: Boolean)
Boolean which indicates if the variable has changed since the last time the boolean was reset.
setHide public setHide(flag: Boolean)
Set whether the variable is hidden or not
setMetadata public setMetadata(name: String, type: Variable.MetadataType, value: Any, access: Variable.MetadataAccess, archive: Boolean)
Set a metadata value on a variable.
setReferenceDebugMode public setReferenceDebugMode(on: Boolean)
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked.
toString public toString(): String
Converts the variable value to a string representation.
toStringAbsolute public toStringAbsolute(): String
Converts the variable value to a string representation.
validate public validate()
Causes the scheduler to get a valid value for this variable.

Connect with Ansys