Interface TradeStudyPlugIn::ITradeStudyPlugIn3

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 479)

COM Instance.

Inherits from:

TradeStudyPlugIn::ITradeStudyPlugIn2

Members

Properties

Property TradeStudyCallback

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 1)

LPDISPATCH TradeStudyPlugIn::ITradeStudyPlugIn3::TradeStudyCallback

Gets or sets the trade study callback object.

Return type: LPDISPATCH

Property saveAllAnalyzerVariables

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 1)

boolean TradeStudyPlugIn::ITradeStudyPlugIn3::saveAllAnalyzerVariables

Gets or sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using addAnalyzerVariable(), otherwise the global ModelCenter setting is used (as per usual). The default is false.

NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added.

Return type: boolean

Property id

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 515)

IDispatch TradeStudyPlugIn::ITradeStudyPlugIn3::id( IDispatch modelCenter, IDispatch addToModel)(IDispatch modelCenter, IDispatch addToModel)

Gets or sets the job manager to use.

Return type: IDispatch

Property show

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 522)

boolean TradeStudyPlugIn::ITradeStudyPlugIn3::show

Called to display the trade study.

Returns:

false always

Return type: boolean

Property toString

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 529)

BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::toString

Called to save the state of the plug-in.

Returns:

a string containing state information

Return type: BSTR

Property fromString

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 536)

BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::fromString

Called to restore the state of a plug-in

Parameters:

setupString: the state string

Return type: BSTR

Property onEnd

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 542)

void TradeStudyPlugIn::ITradeStudyPlugIn3::onEnd

Called when the plug-in is about to be deleted. Informs the plug-in to do any necessary clean up.

Return type: void

Property addAnalyzerVariable

Definition: ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl (line 555)

VARIANT TradeStudyPlugIn::ITradeStudyPlugIn3::addAnalyzerVariable( BSTR formula)(BSTR formula)

Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters.