Skip to main content

ModelCenter APIs 2025 R1

TradeStudy3

Last update: 16.07.2025

public class TradeStudy3 : TradeStudy2

Class that wraps an ITradeStudy3PlugIn COM object.

Author

Dave

Functions

Name Summary
addAnalyzerVariable public addAnalyzerVariable(formula: String, analyzerName: String)
Call to add a variable from an analyzer product.
clearAnalyzerVariables public clearAnalyzerVariables()
Remove all analyzer variables.
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
fromString public fromString(setup: String)
Called to restore the state of a plug-in
getJobManager public getJobManager(): ITradeStudy3JobManager
getSaveAllAnalyzerVariables public getSaveAllAnalyzerVariables(): Boolean
Gets whether all analyzer variables are saved in the data history when the trade study is run.
getTradeStudyCallback public getTradeStudyCallback(): ITradeStudyCallback
Gets the trade study call back object.
onEnd public onEnd()
Called when the plug-in is about to be deleted.
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.
setJobManager public setJobManager(jobManager: ITradeStudy3JobManager)
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.
setSaveAllAnalyzerVariables public setSaveAllAnalyzerVariables(saveAll: Boolean)
Sets whether all analyzer variables are saved in the data history when the trade study is run.
setTradeStudyCallback public setTradeStudyCallback(cb: ITradeStudyCallback)
Sets the trade study call back object.
show public show(): Boolean
Called to display the trade study.
toString public toString(): String
Called to save the state of the plug-in.

Connect with Ansys