DynamicsProgressHandlerProc

The DynamicsProgressHandlerProc function is an application-defined callback function that processes progress notification during a call to C_RunSimulation or C_RunSimulation2. DynamicsProgressHandlerProc is called repeatedly, at frequent intervals, during the simulation.

void __stdcall DynamicsProgressHandlerProc(

TOrcFxAPIHandle ModelHandle,

double SimulationTime,

double SimulationStart,

double SimulationStop,

BOOL *lpCancel

);

Parameters

ModelHandle (IN)

The handle of the model.

SimulationTime (IN)

The current simulation time. This gives a measure of the progress of the simulation. If you wish to report progress as a percentage then you should calculate 100 * (SimulationTime-SimulationStart) / (SimulationStop-SimulationStart).

SimulationStart (IN)

The simulation time at the start of the simulation.

SimulationStop (IN)

The simulation time at which the simulation will be complete.

lpCancel (IN/OUT)

Points to a BOOL variable which determines whether the operation is cancelled – set this BOOL variable non-zero to abort the operation or leave it unchanged to continue.

See also

C_ProcessBatchScript, C_RunSimulation, C_RunSimulation2.