JobManager
Last update: 16.07.2025public class JobManager : PHXCOMObject
This is the wrapper class that handles the native COM calls to a JobManager object. The class is used by Java plug-ins to ModelCenter.
Author
Woyak, 9-01
Functions
| Name | Summary |
|---|---|
| addInput | public addInput(name: String, label: String) adds an input to the Job Table |
| addOutput | public addOutput(name: String, label: String) adds an output to the Job Table |
| addRerun | public addRerun(runNum: Long) designates a given run already in an associated Data Collector to be rerun when submit() is called. |
| clearCache | public clearCache() Clears cache structures |
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| enableCache | public enableCache(enable: Boolean): Boolean Enables or disables cache completely. |
| getInput | public getInput(index: Int): String gets the name of an input variable |
| getInputLabel | public getInputLabel(index: Int): String gets the name of an input variable |
| getNumInputs | public getNumInputs(): Int gets the number of input variables |
| getNumOutputs | public getNumOutputs(): Int gets the number of output variables |
| getNumRuns | public getNumRuns(): Long get number of runs |
| getNumThreads | public getNumThreads(): Int Gets the number of threads to be used when processing a job in parallel |
| getOutput | public getOutput(index: Int): String gets the name of an output variable |
| getOutputLabel | public getOutputLabel(index: Int): String gets the name of an input variable |
| getRunIndex | public getRunIndex(names: Array<String>, values: Array<String>): Int Returns Data Explorer Run Index for the given design from the cache (Only works if cache is enabled. |
| getRunInParallel | public getRunInParallel(): Boolean Determines whether or not the jobs are to be ran in parallel |
| getValidateAll | public getValidateAll(): Boolean return the validate all flag |
| halt | public halt(halt: Boolean) halts the trade study |
| 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. |
| resume | public resume(dh: DataHistory) Pick up from the last checkpoint in a data history. |
| setCustomMetadata | public setCustomMetadata(name: String, key: String, value: String) Add custom metadata to a variable. |
| setInput | public setInput(run: Long, name: String, value: String) sets a given input to a given value for a given run |
| setNumRuns | public setNumRuns(numRuns: Long) get number of runs |
| setNumThreads | public setNumThreads(numThreads: Int) Sets the number of threads to be used when processing a job in parallel |
| 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. |
| setRunInParallel | public setRunInParallel(runInParallel: Boolean) Tells the job manager whether or not to run the jobs in parallel |
| setValidateAll | public setValidateAll(flag: Boolean) set the validate all flag |
| submit | public submit(dc: DataCollector) public submit(dc: DataCollector, description: String) public submit(dc: DataCollector, description: String, fireAndForget: Boolean) start solving the defined table of runs public submit(de: DataExplorer) public submit(dh: DataHistory) public submit(de: DataExplorer, description: String) public submit(dh: DataHistory, description: String) public submit(de: DataExplorer, description: String, fireAndForget: Boolean) public submit(dh: DataHistory, description: String, fireAndForget: Boolean) start solving the defined table of runs. |
| waitForJobCompletion | public waitForJobCompletion() wait for the current job to complete before continuing |
