VariableDescription
Last update: 16.07.2025public class VariableDescription : PHXCOMObject
This is the wrapper class that handles the native COM calls to a data item from a Data Collector. The class is used by Java plug-ins to ModelCenter.
Author
Woyak, 10-01
Properties
| Name | Summary |
|---|---|
| INPUT | val INPUT: Int = 0 |
| OUTPUT | val OUTPUT: Int = 1 |
Functions
| Name | Summary |
|---|---|
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| getEquation | public getEquation(): String if the variable is a custom variable, this function returns the equation used to compute the value for the variable. |
| getFullName | public getFullName(): String gets the full name of the variable, e.g. |
| getName | public getName(): String gets the name of the variable, e.g. |
| getState | public getState(): Int gets the state of the variable, either PHXVariableDescription.INPUT or PHXVariableDescription.OUTPUT. |
| getType | public getType(): String gets the type of the variable, e.g. |
| getUnits | public getUnits(): String gets the units of the variable, if any |
| isCustom | public isCustom(): Boolean indicates if the variable is a custom variable, i.e. |
| isNumeric | public isNumeric(): Boolean indicates if the variable is numeric or not |
| 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. |
| 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. |
