Skip to main content

ModelCenter APIs 2025 R2

ITradeStudy3JobManager

Last update: 16.07.2025

interface ITradeStudy3JobManager : ITradeStudy3JobInfo

Job manager for ITradeStudyPlugIn3

Author

Dave

Functions

Name Summary
addVariable abstract fun addVariable(equation: String, displayName: String, isInput: Boolean)
Add a variable.
canNewJob abstract fun canNewJob(): Boolean
Get whether a new job could be started now.
clear abstract fun clear()
Clear the job manager.
getDataHistory abstract fun getDataHistory(): DataHistory
Get the data history associated with this job manager.
getMetaDataProvider abstract fun getMetaDataProvider(): IVariableMetaDataProvider
Get the variable metadata provider.
getNumRuns abstract fun getNumRuns(): Int
Get the number of runs.
getNumThreads abstract fun getNumThreads(): Int
Get the number of threads that should be used for running in parallel; this is only a hint.
getNumVariables abstract fun getNumVariables(): Int
Get the number of variables.
getRunInParallel abstract fun getRunInParallel(): Boolean
Get whether runs should be in parallel; this is only a hint.
getSupportsParallelExecution abstract fun getSupportsParallelExecution(): Boolean
Get whether this job manager supports parallel execution.
getValidateAll abstract fun getValidateAll(): Boolean
Get whether all outputs will be validated.
getVariableDisplayName abstract fun getVariableDisplayName(index: Int): String
Get the display name for the variable with the specified index.
getVariableEquation abstract fun getVariableEquation(index: Int): String
Get the equation for the variable with the specified index.
isDesignVariable abstract fun isDesignVariable(which: Any): Boolean
Is the specified variable a design variable?
isInput abstract fun isInput(which: Any): Boolean
Is the specified variable an input?
newJob abstract fun newJob(numRuns: Int)
Start setting up a new job.
runJobAsync abstract fun runJobAsync(): ITradeStudy3JobResult
Start the job.
setDataHistory abstract fun setDataHistory(dataHistory: DataHistory)
Set the data history associated with this job manager.
setInput abstract fun setInput(runIndex: Int, which: Any, value: Any)
Set an input.
setNumThreads abstract fun setNumThreads(numThreads: Int)
Get the number of threads that should be used for running in parallel; this is only a hint.
setRunInParallel abstract fun setRunInParallel(runInParallel: Boolean)
Set whether runs should be in parallel; this is only a hint.
setRunInputs abstract fun setRunInputs(runIndex: Int, values: Array<Any>, which: Array<Any>)
Set some/all of the inputs for a given run.
setValidateAll abstract fun setValidateAll(validateAll: Boolean)
Get whether all outputs will be validated.
setVariableInputs abstract fun setVariableInputs(which: Any, values: Array<Any>, runIndices: Array<Int>)
Set some/all inputs for a particular variable, across runs.

Connect with Ansys