Pointwise Plugin SDK
|
Functions | |
PWP_BOOL | grdpProgressBeginStep (GRDP_RTITEM *pRti, PWP_UINT32 total) |
Begins a progress tracking step. More... | |
PWP_BOOL | grdpProgressEnd (GRDP_RTITEM *pRti, const PWP_BOOL ok) |
Ends all progress tracking. More... | |
PWP_BOOL | grdpProgressEndStep (GRDP_RTITEM *pRti) |
Completes a progress tracking major step. More... | |
PWP_BOOL | grdpProgressIncr (GRDP_RTITEM *pRti) |
Completes a progress tracking sub-step. More... | |
PWP_BOOL | grdpProgressInit (GRDP_RTITEM *pRti, PWP_UINT32 cnt) |
Initializes a progress tracking session. More... | |
Bundle and send a progress message back to framework. These are wrappers for the lower level PwuProgressXxxx() functions.
PWP_BOOL grdpProgressBeginStep | ( | GRDP_RTITEM * | pRti, |
PWP_UINT32 | total | ||
) |
Begins a progress tracking step.
Called by a plugin before begining a major import step.
pRti | The GRDP_RTITEM pointer passed into runtimeWrite(). |
total | The number of sub-steps in this major step. |
Definition at line 65 of file apiGRDPUtils.cxx.
References GRDP_CLKS_BEGSTEP, and PWP_FALSE.
PWP_BOOL grdpProgressEnd | ( | GRDP_RTITEM * | pRti, |
const PWP_BOOL | ok | ||
) |
Ends all progress tracking.
Called by a plugin after all major steps are completed or when exiting early for an import error.
pRti | The GRDP_RTITEM pointer passed into runtimeWrite(). |
ok | Set to PWP_TRUE/PWP_FALSE to indicate sucess/failure. |
Definition at line 154 of file apiGRDPUtils.cxx.
References PWU_RTITEM::apiInfo, GRDP_CLKS_PROGEND, GRDP_CLKS_PROGINIT, GRDP_CLKS_PROGUPDATE, PWP_APIINFO::name, GRDP_RTITEM::pApiData, PwuProgressEnd(), and sendClkDiffTimeMsg().
PWP_BOOL grdpProgressEndStep | ( | GRDP_RTITEM * | pRti | ) |
Completes a progress tracking major step.
Called by a plugin after each import major step is completed.
pRti | The GRDP_RTITEM pointer passed into runtimeWrite(). |
Definition at line 137 of file apiGRDPUtils.cxx.
References PWU_RTITEM::apiInfo, GRDP_CLKS_BEGSTEP, GRDP_CLKS_ENDSTEP, PWP_APIINFO::name, GRDP_RTITEM::pApiData, PWP_FALSE, PwuProgressNextStep(), and sendClkDiffTimeMsg().
PWP_BOOL grdpProgressIncr | ( | GRDP_RTITEM * | pRti | ) |
Completes a progress tracking sub-step.
Called by a plugin after each import sub-step is completed.
pRti | The GRDP_RTITEM pointer passed into runtimeWrite(). |
Definition at line 79 of file apiGRDPUtils.cxx.
References PWU_RTITEM::apiInfo, GRDP_CLKS_PROGINCR, GRDP_CLKS_PROGUPDATE, GRDP_RT_CLKS_DIFF, PWP_APIINFO::name, GRDP_RTITEM::pApiData, PWP_FALSE, PWP_TRUE, and PwuProgressStatus().
PWP_BOOL grdpProgressInit | ( | GRDP_RTITEM * | pRti, |
PWP_UINT32 | cnt | ||
) |
Initializes a progress tracking session.
Called once by a plugin before an import begins.
pRti | The GRDP_RTITEM pointer passed into runtimeWrite(). |
cnt | The number of major steps to be used for this import session. |
Definition at line 48 of file apiGRDPUtils.cxx.
References PWU_RTITEM::apiInfo, GRDP_CLKS_PROGINIT, GRDP_CLKS_PROGUPDATE, PWP_APIINFO::name, GRDP_RTITEM::pApiData, PWP_FALSE, and PwuProgressBegin().