Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros
+ Collaboration diagram for GRDP Macros:

Macros

#define GRDP_CLKS_TO_FSECS(c)   ((PWP_FLOAT)(c) / (PWP_FLOAT)CLOCKS_PER_SEC)
 Returns the clock value c as seconds (PWP_FLOAT). More...
 
#define GRDP_CLKS_TO_HMS(c, h, m, s)
 Returns the clock value c decomposed into hours, minutes, and seconds (PWP_INT32). That is, c == (h * 3600 + m * 60 + s) * CLOCKS_PER_SEC. More...
 
#define GRDP_CLKS_TO_HOURS(c)   (GRDP_CLKS_TO_MINS(c) / 60)
 Returns the clock value c as hours (PWP_INT32). Only whole hour values are possible. More...
 
#define GRDP_CLKS_TO_MINS(c)   (GRDP_CLKS_TO_SECS(c) / 60)
 Returns the clock value c as minutes (PWP_INT32). Only whole minute values are possible. More...
 
#define GRDP_CLKS_TO_MSECS(c)   ((PWP_INT32)((c) * 1000) / CLOCKS_PER_SEC)
 Returns the clock value c as milli seconds (PWP_INT32). Only whole ms values are possible. More...
 
#define GRDP_CLKS_TO_SECS(c)   ((PWP_INT32)(c) / CLOCKS_PER_SEC)
 Returns the clock value c as seconds (PWP_INT32). Only whole second values are possible. More...
 
#define GRDP_IS_CLKS_ID(id)   PWP_CAST_BOOL(((id) >= 0) && ((id) <= GRDP_CLKS_LAST))
 Returns PWP_TRUE if id is a valid GRDP_ENUM_CLOCKS id. More...
 
#define GRDP_RT_ABORT(rti)   ((rti)->opAborted = PWP_TRUE)
 Used by plugin to mark the import operation as aborted. More...
 
#define GRDP_RT_CLKS_DIFF(rti, startId, endId)
 Returns the clock time difference between startId and endId as clocks[endId] - clocks[startId]. The ids are validated. More...
 
#define GRDP_RT_CLKS_DIFF_STEP(rti)   GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_BEGSTEP, GRDP_CLKS_ENDSTEP)
 Returns the current clock time difference between GRDP_CLKS_BEGSTEP and GRDP_CLKS_ENDSTEP. More...
 
#define GRDP_RT_CLKS_DIFF_TOTAL(rti)   GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_PROGINIT, GRDP_CLKS_PROGEND)
 Returns the current clock time difference between GRDP_CLKS_PROGINIT and GRDP_CLKS_PROGEND. More...
 
#define GRDP_RT_CLKS_ID(rti, id)   (GRDP_IS_CLKS_ID(id)? (rti)->clocks[id]: 0)
 Returns the clock time value for the given id. The id is validated. More...
 
#define GRDP_RT_CLKS_POLL(rti, id)   GRDP_RT_CLKS_DIFF(rti, id, GRDP_CLKS_PROGINCR)
 Returns the current clock time difference between id and GRDP_CLKS_PROGINCR. More...
 
#define GRDP_RT_CLKS_POLL_STEP(rti)   GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_BEGSTEP)
 Returns the current clock time difference between GRDP_CLKS_BEGSTEP and GRDP_CLKS_PROGINCR. More...
 
#define GRDP_RT_CLKS_POLL_TOTAL(rti)   GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_PROGINIT)
 Returns the current clock time difference between GRDP_CLKS_PROGINIT and GRDP_CLKS_PROGINCR. More...
 
#define GRDP_RT_IMPORT_CONDITIONS(rti)   (rti)->pReadInfo->importConditions
 Returns PWP_TRUE if condition import is requested. More...
 
#define GRDP_RT_IS_ABORTED(rti)   PWP_CAST_BOOL((rti)->opAborted)
 Returns PWP_TRUE if the import has been aborted by the user or the plugin itself. More...
 

Detailed Description

Macros that work with various GRDP data types.

Macro Definition Documentation

#define GRDP_CLKS_TO_FSECS (   c)    ((PWP_FLOAT)(c) / (PWP_FLOAT)CLOCKS_PER_SEC)

Returns the clock value c as seconds (PWP_FLOAT).

Definition at line 722 of file apiGRDPUtils.h.

#define GRDP_CLKS_TO_HMS (   c,
  h,
  m,
 
)
Value:
(s = GRDP_CLKS_TO_SECS(c)), \
(h = s / 3600), (s -= h * 3600), \
(m = s / 60), \
(s -= m * 60)
#define GRDP_CLKS_TO_SECS(c)
Returns the clock value c as seconds (PWP_INT32). Only whole second values are possible.
Definition: apiGRDPUtils.h:694

Returns the clock value c decomposed into hours, minutes, and seconds (PWP_INT32). That is, c == (h * 3600 + m * 60 + s) * CLOCKS_PER_SEC.

Definition at line 713 of file apiGRDPUtils.h.

Referenced by sendDiffTimeMsg().

#define GRDP_CLKS_TO_HOURS (   c)    (GRDP_CLKS_TO_MINS(c) / 60)

Returns the clock value c as hours (PWP_INT32). Only whole hour values are possible.

Definition at line 706 of file apiGRDPUtils.h.

#define GRDP_CLKS_TO_MINS (   c)    (GRDP_CLKS_TO_SECS(c) / 60)

Returns the clock value c as minutes (PWP_INT32). Only whole minute values are possible.

Definition at line 700 of file apiGRDPUtils.h.

#define GRDP_CLKS_TO_MSECS (   c)    ((PWP_INT32)((c) * 1000) / CLOCKS_PER_SEC)

Returns the clock value c as milli seconds (PWP_INT32). Only whole ms values are possible.

Definition at line 688 of file apiGRDPUtils.h.

Referenced by sendDiffTimeMsg().

#define GRDP_CLKS_TO_SECS (   c)    ((PWP_INT32)(c) / CLOCKS_PER_SEC)

Returns the clock value c as seconds (PWP_INT32). Only whole second values are possible.

Definition at line 694 of file apiGRDPUtils.h.

#define GRDP_IS_CLKS_ID (   id)    PWP_CAST_BOOL(((id) >= 0) && ((id) <= GRDP_CLKS_LAST))

Returns PWP_TRUE if id is a valid GRDP_ENUM_CLOCKS id.

Definition at line 633 of file apiGRDPUtils.h.

#define GRDP_RT_ABORT (   rti)    ((rti)->opAborted = PWP_TRUE)

Used by plugin to mark the import operation as aborted.

Definition at line 628 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_DIFF (   rti,
  startId,
  endId 
)
Value:
((GRDP_IS_CLKS_ID(startId) && GRDP_IS_CLKS_ID(endId)) ? \
((rti)->clocks[endId] - (rti)->clocks[startId]) : 0)
#define GRDP_IS_CLKS_ID(id)
Returns PWP_TRUE if id is a valid GRDP_ENUM_CLOCKS id.
Definition: apiGRDPUtils.h:633

Returns the clock time difference between startId and endId as clocks[endId] - clocks[startId]. The ids are validated.

Definition at line 645 of file apiGRDPUtils.h.

Referenced by grdpProgressIncr(), and sendClkDiffTimeMsg().

#define GRDP_RT_CLKS_DIFF_STEP (   rti)    GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_BEGSTEP, GRDP_CLKS_ENDSTEP)

Returns the current clock time difference between GRDP_CLKS_BEGSTEP and GRDP_CLKS_ENDSTEP.

Definition at line 667 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_DIFF_TOTAL (   rti)    GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_PROGINIT, GRDP_CLKS_PROGEND)

Returns the current clock time difference between GRDP_CLKS_PROGINIT and GRDP_CLKS_PROGEND.

Definition at line 681 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_ID (   rti,
  id 
)    (GRDP_IS_CLKS_ID(id)? (rti)->clocks[id]: 0)

Returns the clock time value for the given id. The id is validated.

Definition at line 639 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_POLL (   rti,
  id 
)    GRDP_RT_CLKS_DIFF(rti, id, GRDP_CLKS_PROGINCR)

Returns the current clock time difference between id and GRDP_CLKS_PROGINCR.

Definition at line 653 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_POLL_STEP (   rti)    GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_BEGSTEP)

Returns the current clock time difference between GRDP_CLKS_BEGSTEP and GRDP_CLKS_PROGINCR.

Definition at line 660 of file apiGRDPUtils.h.

#define GRDP_RT_CLKS_POLL_TOTAL (   rti)    GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_PROGINIT)

Returns the current clock time difference between GRDP_CLKS_PROGINIT and GRDP_CLKS_PROGINCR.

Definition at line 674 of file apiGRDPUtils.h.

#define GRDP_RT_IMPORT_CONDITIONS (   rti)    (rti)->pReadInfo->importConditions

Returns PWP_TRUE if condition import is requested.

Definition at line 616 of file apiGRDPUtils.h.

#define GRDP_RT_IS_ABORTED (   rti)    PWP_CAST_BOOL((rti)->opAborted)

Returns PWP_TRUE if the import has been aborted by the user or the plugin itself.

Definition at line 623 of file apiGRDPUtils.h.