DHVariable
Last update: 16.07.2025public class DHVariable : PHXCOMObject
This is the wrapper class that handles the native COM calls to a Data History Variable. The class is used by Java plug-ins to ModelCenter.
Constructors
| DHVariable | constructor(id: Long) Connects this Java object to the specified session of ModelCenter constructor(id: Long, addRef: Boolean) |
Functions
| Name | Summary |
|---|---|
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| getEnumAlias | public getEnumAlias(index: Long): String gets the Enum Alias given an index |
| getEnumAliases | public getEnumAliases(): String gets the Enum Aliases |
| getEnumValue | public getEnumValue(index: Long): String gets the Enum Value |
| getEnumValues | public getEnumValues(): String gets the Enum Values |
| getEquation | public getEquation(): String gets the Equation |
| getFormat | public getFormat(): String gets the format |
| getLowerBound | public getLowerBound(): Any gets the LowerBound |
| getMetaData | public getMetaData(key: String): String gets the specified meta data |
| getName | public getName(): String returns the name |
| getNumEnumAlias | public getNumEnumAlias(): Long gets the number of Enum Alias |
| getNumEnumValues | public getNumEnumValues(): Long gets the Number of Enum Values |
| getType | public getType(): String gets the type |
| getUnits | public getUnits(): String get the units |
| getUpperBound | public getUpperBound(): Any returns the Upper Bound |
| isDesignVar | public isDesignVar(): Boolean checks to see if there is a Design Variable |
| isInput | public isInput(): Boolean checks for input |
| isNumeric | public isNumeric(): Boolean checks to see if numeric |
| 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. |
| removeMetadata | public removeMetadata(key: String) removes the metadata for the specified key |
| setDesignVar | public setDesignVar(isDesignVar: Boolean) sets if this is a Design Variable |
| setEnumAliases | public setEnumAliases(aliases: String) sets the Enum Aliases |
| setEnumValues | public setEnumValues(values: String) sets the Enum Values |
| setEquation | public setEquation(equation: String) sets the Equation |
| setFormat | public setFormat(format: String) sets the format |
| setInput | public setInput(isInput: Boolean) sets whether the variable is an input |
| setLowerBound | public setLowerBound(lwrBnd: Any) gets ModelCenter --was IDispatch in COM |
| setMetaData | public setMetaData(key: String, value: String) sets the specified meta data |
| setName | public setName(name: String) sets the name |
| setNumeric | public setNumeric(isNumeric: Boolean) Sets whether or not the variable represents a numeric value. |
| 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. |
| setType | public setType(type: String) sets the type |
| setUnits | public setUnits(units: String) sets the units |
| setUpperBound | public setUpperBound(upprBnd: Any) sets the Upper Bound |
