Pointwise Plugin SDK
Functions
+ Collaboration diagram for Progress Handling:

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...
 

Detailed Description

Bundle and send a CAE progress message back to framework. These are wrappers for the lower level PwuProgressXxxx() functions.

See also
PwuProgressBegin(), PwuProgressEnd(), PwuProgressStatus(), PwuProgressNextStep(), PwuProgressQuit()

Function Documentation

◆ caeuProgressBeginStep()

PWP_BOOL caeuProgressBeginStep ( CAEP_RTITEM pRti,
PWP_UINT32  total 
)

Begins a progress tracking step.

Called by a plugin before begining a major export step.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
totalThe number of sub-steps in this major step.
Note
See example usage in caeuProgressInit().

Definition at line 68 of file apiCAEPUtils.cxx.

References CAEPU_CLKS_BEGSTEP, and PWP_FALSE.

Referenced by CaePlugin< MT >::progressBeginStep().

◆ caeuProgressEnd()

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.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
okSet to PWP_TRUE/PWP_FALSE to indicate sucess/failure.
Note
See example usage in caeuProgressInit().

Definition at line 157 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().

◆ caeuProgressEndStep()

PWP_BOOL caeuProgressEndStep ( CAEP_RTITEM pRti)

Completes a progress tracking major step.

Called by a plugin after each export major step is completed.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
Note
See example usage in caeuProgressInit().

Definition at line 140 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, CAEPU_CLKS_BEGSTEP, CAEPU_CLKS_ENDSTEP, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PWP_FALSE, PwuProgressNextStep(), and sendClkDiffTimeMsg().

Referenced by CaePlugin< MT >::progressEndStep().

◆ caeuProgressIncr()

PWP_BOOL caeuProgressIncr ( CAEP_RTITEM pRti)

Completes a progress tracking sub-step.

Called by a plugin after each export sub-step is completed.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
Note
See example usage in caeuProgressInit().

Definition at line 82 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().

◆ caeuProgressInit()

PWP_BOOL caeuProgressInit ( CAEP_RTITEM pRti,
PWP_UINT32  cnt 
)

Initializes a progress tracking session.

Called once by a plugin before an export begins.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
cntThe number of major steps to be used for this export session.
Sample usage:
// Set a total of 3 MAJOR progress steps.
if (caeuProgressInit(pRti, 3)) {
// begin MAJOR step 1 composed of 44 sub-steps
if (ok = caeuProgressBeginStep(pRti, 44)) {
int ii;
for (ii=0; ii < 44 && ok; ++ii) {
// repeat for the 44 sub-steps
ok = caeuProgressIncr(pRti);
}
// This call is optional. It is valid to call
// caeuProgressBeginStep() or caeuProgressEnd() instead.
if (ok) {
ok = caeuProgressEndStep(pRti);
}
}
// begin MAJOR step 2 composed of 22 sub-steps
if (ok && ok = caeuProgressBeginStep(pRti, 22)) {
...snip...
}
// begin MAJOR step 3 composed of 10 sub-steps
if (ok && ok = caeuProgressBeginStep(pRti, 10)) {
...snip...
}
caeuProgressEnd(pRti, ok);
}

Definition at line 51 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, CAEPU_CLKS_PROGINIT, CAEPU_CLKS_PROGUPDATE, PWP_APIINFO::name, CAEP_RTITEM::pApiData, PWP_FALSE, and PwuProgressBegin().

Referenced by CaePlugin< MT >::run(), and runtimeWrite().