ModelCenter APIs 2026 R1

Interface TradeStudyPlugIn::ITradeStudy3JobResult

Last update: 18.06.2026

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

Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not.

Members

Properties

Property numRuns

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

TradeStudyPlugIn::ITradeStudy3JobResult::numRuns

Get the number of runs.

Return type:

Property numVariables

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

TradeStudyPlugIn::ITradeStudy3JobResult::numVariables

Get the number of inputs.

Return type:

Property dataHistory

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

TradeStudyPlugIn::ITradeStudy3JobResult::dataHistory

Get the data history associated with this job result, if any.

Return type:

Property isRunning

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

TradeStudyPlugIn::ITradeStudy3JobResult::isRunning

Is the current job still running.

Return type:

Property isCanceled

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

TradeStudyPlugIn::ITradeStudy3JobResult::isCanceled

Was the current job canceled?

Return type:

Public functions

Function getVariableEquation

BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableEquation(long index)

Get the equation for the variable at the specified index.

Parameters:

  • index: The index.

Returns:

The equation.

Parameters:

  • long index

Return type: BSTR

Function getVariableDisplayName

BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableDisplayName(long index)

Get the unique display name of a variable.

Parameters:

  • index: The index.

Returns:

The display name.

Parameters:

  • long index

Return type: BSTR

Function isDesignVariable

boolean TradeStudyPlugIn::ITradeStudy3JobResult::isDesignVariable(VARIANT which)

Get the type associated with the specified variable.

Parameters:

  • which: The name or index of the variable.

Returns:

The variable type.

Parameters:

  • VARIANT which

Return type: boolean

Function isInput

boolean TradeStudyPlugIn::ITradeStudy3JobResult::isInput(VARIANT which)

Get the type associated with the specified variable.

Parameters:

  • which: The name or index of the variable.

Returns:

The variable type.

Parameters:

  • VARIANT which

Return type: boolean

Function cancelAsync

void TradeStudyPlugIn::ITradeStudy3JobResult::cancelAsync()

Halt the current job asynchronously.

Return type: void

Function waitForCompletion

void TradeStudyPlugIn::ITradeStudy3JobResult::waitForCompletion()

Wait for the trade study to finish.

Exceptions:

  • OperationCanceledException: If the operation was halted.

Return type: void

Connect with Ansys