DataCollector
Last update: 16.07.2025public class DataCollector : PHXCOMObject
This is the wrapper class that handles the native COM calls to a Data Collector. The class is used by Java plug-ins to ModelCenter.
Author
Woyak, 9-01
Constructors
| DataCollector | constructor(pstrm: Long) Connects this Java object to the specified session of ModelCenter |
Functions
| Name | Summary |
|---|---|
| addCustom | public addCustom(eqn: String, label: String) adds a custom variable to be displayed in the Data Collector |
| createEmptyRuns | public createEmptyRuns(numEmptyRuns: Long) For internal use only |
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| enableCarpetPlotTab | public enableCarpetPlotTab(var1: String, var2: String, plotVar: String) public enableCarpetPlotTab(id: Long, var1: String, var2: String, plotVar: String) For internal use only |
| enableGraphTab | public enableGraphTab(flag: Boolean) Enables the Graph tab |
| enableMainEffectsTab | public enableMainEffectsTab() For internal use only |
| endRuns | public endRuns() lets the Data Collector know that all runs have completed |
| exportToCSV | public exportToCSV(fileName: String) exports the trade study data to a comma-separated file |
| fromString | public fromString(str: String) Restores a Data Collector setup from a string generated by "toString" |
| getDataExplorer | public getDataExplorer(): DataExplorer Gets the associated Data Explorer window |
| getErrorID | public getErrorID(run: Long): Long get the error id for the specified run |
| getErrorMessage | public getErrorMessage(run: Long): String gets the error message associated with the specified run |
| getNumFailedRuns | public getNumFailedRuns(): Long gets the number of failed runs |
| getNumRuns | public getNumRuns(): Long gets the number of runs stored in the Data Collector |
| getNumVariables | public getNumVariables(): Long gets the number of variables stored in the Data Collector |
| getValue | public getValue(name: String, run: Long): Variant public getValue(index: Long, run: Long): Variant gets the value for a specified variable |
| getVariableDescription | public getVariableDescription(name: String): VariableDescription public getVariableDescription(index: Long): VariableDescription gets a description object for the specified variable |
| hide | public hide() caused the Data Collector to hide |
| isValid | public isValid(name: String, run: Long): Boolean public isValid(index: Long, run: Long): Boolean checks to see if a variable value is valid or not |
| isVisible | public isVisible(): Boolean Determine if the data collector is visible. |
| newCustomDesignPoint | public newCustomDesignPoint(): CustomDesignPoint For internal use only |
| newInstance | public newInstance(): DataCollector creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. |
| 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. |
| save | public save(fileName: String, displayName: String, description: String, author: String, saveModel: Boolean) saves the trade study |
| selectX | public selectX(label: String) selects a variable for the X-axis |
| selectY | public selectY(label: String) selects a variable for the Y-axis |
| setCustomRun | public setCustomRun(index: Long, customDesignPoint: CustomDesignPoint) For internal use only |
| setNumExpectedRuns | public setNumExpectedRuns(numRuns: Long) lets the Data Collector how many runs are expected. |
| 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. |
| show | public show() caused the Data Collector to be displayed |
| startRuns | public startRuns() lets the Data Collector know that it has been setup and runs are beginning |
| storeCurrentDesignPoint | public storeCurrentDesignPoint() causes the Data Collector to store the current data from ModelCenter |
| storeCustomDesignPoint | public storeCustomDesignPoint(customDesignPoint: CustomDesignPoint) For internal use only |
| toString | public toString(): String Converts the Data Collector setup to a string |
