Pointwise Plugin SDK
|
Functions | |
PWP_BOOL | caeuProgressBeginStep (CAEP_RTITEM *pRti, PWP_UINT32 total) |
Begins a progress tracking step. More... | |
void | caeuProgressEnd (CAEP_RTITEM *pRti, PWP_BOOL ok) |
Ends all progress tracking. More... | |
PWP_BOOL | caeuProgressEndStep (CAEP_RTITEM *pRti) |
Completes a progress tracking major step. More... | |
PWP_BOOL | caeuProgressIncr (CAEP_RTITEM *pRti) |
Completes a progress tracking sub-step. More... | |
PWP_BOOL | caeuProgressInit (CAEP_RTITEM *pRti, PWP_UINT32 cnt) |
Initializes a progress tracking session. More... | |
Bundle and send a CAE progress message back to framework. These are wrappers for the lower level PwuProgressXxxx() functions.
PWP_BOOL caeuProgressBeginStep | ( | CAEP_RTITEM * | pRti, |
PWP_UINT32 | total | ||
) |
Begins a progress tracking step.
Called by a plugin before begining a major export step.
pRti | The CAEP_RTITEM pointer passed into runtimeWrite(). |
total | The number of sub-steps in this major step. |
Definition at line 70 of file apiCAEPUtils.cxx.
References PWU_RTITEM::apiInfo, CAEPU_CLKS_BEGSTEP, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PWP_CAST_BOOL, PWP_UINT32_MAX, and PwuProgressNextStep().
Referenced by CaePlugin< MT >::progressBeginStep().
void caeuProgressEnd | ( | CAEP_RTITEM * | pRti, |
PWP_BOOL | ok | ||
) |
Ends all progress tracking.
Called by a plugin after all major steps are completed or when exiting early for an export error.
pRti | The CAEP_RTITEM pointer passed into runtimeWrite(). |
ok | Set to PWP_TRUE/PWP_FALSE to indicate sucess/failure. |
Definition at line 161 of file apiCAEPUtils.cxx.
References PWU_RTITEM::apiInfo, CAEPU_CLKS_PROGEND, CAEPU_CLKS_PROGINIT, CAEPU_CLKS_PROGUPDATE, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PwuProgressEnd(), and sendClkDiffTimeMsg().
Referenced by CaePlugin< MT >::run(), and runtimeWrite().
PWP_BOOL caeuProgressEndStep | ( | CAEP_RTITEM * | pRti | ) |
Completes a progress tracking major step.
Called by a plugin after each export major step is completed.
pRti | The CAEP_RTITEM pointer passed into runtimeWrite(). |
Definition at line 146 of file apiCAEPUtils.cxx.
References CAEPU_CLKS_BEGSTEP, CAEPU_CLKS_ENDSTEP, PWP_CAST_BOOL, and sendClkDiffTimeMsg().
Referenced by CaePlugin< MT >::progressEndStep().
PWP_BOOL caeuProgressIncr | ( | CAEP_RTITEM * | pRti | ) |
Completes a progress tracking sub-step.
Called by a plugin after each export sub-step is completed.
pRti | The CAEP_RTITEM pointer passed into runtimeWrite(). |
Definition at line 89 of file apiCAEPUtils.cxx.
References PWU_RTITEM::apiInfo, CAEPU_CLKS_PROGINCR, CAEPU_CLKS_PROGUPDATE, CAEPU_RT_CLKS_DIFF, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PWP_FALSE, PWP_TRUE, and PwuProgressStatus().
Referenced by CaePlugin< MT >::progressIncrement().
PWP_BOOL caeuProgressInit | ( | CAEP_RTITEM * | pRti, |
PWP_UINT32 | cnt | ||
) |
Initializes a progress tracking session.
Called once by a plugin before an export begins.
pRti | The CAEP_RTITEM pointer passed into runtimeWrite(). |
cnt | The number of major steps to be used for this export session. |
Definition at line 53 of file apiCAEPUtils.cxx.
References PWU_RTITEM::apiInfo, CAEPU_CLKS_PROGINIT, CAEPU_CLKS_PROGUPDATE, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PWP_FALSE, PWP_UINT32_MAX, and PwuProgressBegin().
Referenced by CaePlugin< MT >::run(), and runtimeWrite().