Pointwise Plugin SDK
|
Macros | |
#define | CAEPU_CLKS_TO_FSECS(c) ((PWP_FLOAT)(c) / (PWP_FLOAT)CLOCKS_PER_SEC) |
Returns the clock value c as seconds (PWP_FLOAT). More... | |
#define | CAEPU_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 | CAEPU_CLKS_TO_HOURS(c) (CAEPU_CLKS_TO_MINS(c) / 60) |
Returns the clock value c as hours (PWP_INT32). Only whole hour values are possible. More... | |
#define | CAEPU_CLKS_TO_MINS(c) (CAEPU_CLKS_TO_SECS(c) / 60) |
Returns the clock value c as minutes (PWP_INT32). Only whole minute values are possible. More... | |
#define | CAEPU_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 | CAEPU_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 | CAEPU_IS_CLKS_ID(id) PWP_CAST_BOOL(((id) >= 0) && ((id) <= CAEPU_CLKS_LAST)) |
Returns PWP_TRUE if id is a valid CAEPU_ENUM_CLOCKS id. More... | |
#define | CAEPU_RT_ABORT(rti) ((rti)->opAborted = PWP_TRUE) |
Used by plugin to mark the export operation as aborted. More... | |
#define | CAEPU_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 | CAEPU_RT_CLKS_DIFF_STEP(rti) CAEPU_RT_CLKS_DIFF(rti, CAEPU_CLKS_BEGSTEP, CAEPU_CLKS_ENDSTEP) |
Returns the current clock time difference between CAEPU_CLKS_BEGSTEP and CAEPU_CLKS_ENDSTEP. More... | |
#define | CAEPU_RT_CLKS_DIFF_TOTAL(rti) CAEPU_RT_CLKS_DIFF(rti, CAEPU_CLKS_PROGINIT, CAEPU_CLKS_PROGEND) |
Returns the current clock time difference between CAEPU_CLKS_PROGINIT and CAEPU_CLKS_PROGEND. More... | |
#define | CAEPU_RT_CLKS_ID(rti, id) (CAEPU_IS_CLKS_ID(id)? (rti)->clocks[id]: 0) |
Returns the clock time value for the given id. The id is validated. More... | |
#define | CAEPU_RT_CLKS_POLL(rti, id) CAEPU_RT_CLKS_DIFF(rti, id, CAEPU_CLKS_PROGINCR) |
Returns the current clock time difference between id and CAEPU_CLKS_PROGINCR. More... | |
#define | CAEPU_RT_CLKS_POLL_STEP(rti) CAEPU_RT_CLKS_POLL(rti, CAEPU_CLKS_BEGSTEP) |
Returns the current clock time difference between CAEPU_CLKS_BEGSTEP and CAEPU_CLKS_PROGINCR. More... | |
#define | CAEPU_RT_CLKS_POLL_TOTAL(rti) CAEPU_RT_CLKS_POLL(rti, CAEPU_CLKS_PROGINIT) |
Returns the current clock time difference between CAEPU_CLKS_PROGINIT and CAEPU_CLKS_PROGINCR. More... | |
#define | CAEPU_RT_DIM(rti) (rti)->pWriteInfo->dimension |
Get the export dimension from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_DIM_2D(rti) CAEPU_RT_DIM_IS(rti, PWP_DIMENSION_2D) |
Returns PWP_TRUE if export dimension is PWP_DIMENSION_2D. More... | |
#define | CAEPU_RT_DIM_3D(rti) CAEPU_RT_DIM_IS(rti, PWP_DIMENSION_3D) |
Returns PWP_TRUE if export dimension is PWP_DIMENSION_3D. More... | |
#define | CAEPU_RT_DIM_IS(rti, d) PWP_CAST_BOOL((d) == CAEPU_RT_DIM(rti)) |
Returns PWP_TRUE if export dimension is d. More... | |
#define | CAEPU_RT_DIM_TEXT(rti) caeuDimensionToText((rti)->pWriteInfo->dimension) |
Get the export dimension text from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_ENC_ASCII(rti) CAEPU_RT_ENC_IS(rti, PWP_ENCODING_ASCII) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_ASCII. More... | |
#define | CAEPU_RT_ENC_BINARY(rti) CAEPU_RT_ENC_IS(rti, PWP_ENCODING_BINARY) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_BINARY. More... | |
#define | CAEPU_RT_ENC_IS(rti, e) PWP_CAST_BOOL((e) == CAEPU_RT_ENCODING(rti)) |
Returns PWP_TRUE if export encoding is enc. More... | |
#define | CAEPU_RT_ENC_UNFORMATTED(rti) CAEPU_RT_ENC_IS(rti, PWP_ENCODING_UNFORMATTED) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_UNFORMATTED. More... | |
#define | CAEPU_RT_ENCODING(rti) (rti)->pWriteInfo->encoding |
Get the export encoding from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_ENCODING_TEXT(rti) caeuEncodeToText((rti)->pWriteInfo->encoding) |
Get the export precision text from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_IS_ABORTED(rti) PWP_CAST_BOOL((rti)->opAborted) |
Returns PWP_TRUE if the export has been aborted by the user or the plugin itself. More... | |
#define | CAEPU_RT_PREC(rti) (rti)->pWriteInfo->precision |
Get the export precision from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_PREC_DOUBLE(rti) CAEPU_RT_PREC_IS(rti, PWP_PRECISION_DOUBLE) |
Returns PWP_TRUE if export dimension is PWP_PRECISION_DOUBLE. More... | |
#define | CAEPU_RT_PREC_IS(rti, prec) PWP_CAST_BOOL((prec) == CAEPU_RT_PREC(rti)) |
Returns PWP_TRUE if export precision is prec. More... | |
#define | CAEPU_RT_PREC_SINGLE(rti) CAEPU_RT_PREC_IS(rti, PWP_PRECISION_SINGLE) |
Returns PWP_TRUE if export precision is PWP_PRECISION_SINGLE. More... | |
#define | CAEPU_RT_PREC_TEXT(rti) caeuPrecisionToText((rti)->pWriteInfo->precision) |
Get the export precision text from CAEP_RTITEM data pointed to by rti. More... | |
#define | CAEPU_RT_TRY(rti, theOp) |
Attempt theOp and abort the export if needed. Returns PWP_FALSE if the export operation is marked as aborted. More... | |
Macros that work with various CAEP data types.
Returns the clock value c as seconds (PWP_FLOAT).
Definition at line 1007 of file apiCAEPUtils.h.
#define CAEPU_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.
Definition at line 998 of file apiCAEPUtils.h.
#define CAEPU_CLKS_TO_HOURS | ( | c | ) | (CAEPU_CLKS_TO_MINS(c) / 60) |
Returns the clock value c as hours (PWP_INT32). Only whole hour values are possible.
Definition at line 991 of file apiCAEPUtils.h.
#define CAEPU_CLKS_TO_MINS | ( | c | ) | (CAEPU_CLKS_TO_SECS(c) / 60) |
Returns the clock value c as minutes (PWP_INT32). Only whole minute values are possible.
Definition at line 985 of file apiCAEPUtils.h.
#define CAEPU_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 973 of file apiCAEPUtils.h.
#define CAEPU_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 979 of file apiCAEPUtils.h.
#define CAEPU_IS_CLKS_ID | ( | id | ) | PWP_CAST_BOOL(((id) >= 0) && ((id) <= CAEPU_CLKS_LAST)) |
Returns PWP_TRUE if id is a valid CAEPU_ENUM_CLOCKS id.
Definition at line 918 of file apiCAEPUtils.h.
#define CAEPU_RT_ABORT | ( | rti | ) | ((rti)->opAborted = PWP_TRUE) |
Used by plugin to mark the export operation as aborted.
Definition at line 868 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_DIFF | ( | rti, | |
startId, | |||
endId | |||
) |
Returns the clock time difference between startId and endId as clocks[endId] - clocks[startId]. The ids are validated.
Definition at line 930 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_DIFF_STEP | ( | rti | ) | CAEPU_RT_CLKS_DIFF(rti, CAEPU_CLKS_BEGSTEP, CAEPU_CLKS_ENDSTEP) |
Returns the current clock time difference between CAEPU_CLKS_BEGSTEP and CAEPU_CLKS_ENDSTEP.
Definition at line 952 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_DIFF_TOTAL | ( | rti | ) | CAEPU_RT_CLKS_DIFF(rti, CAEPU_CLKS_PROGINIT, CAEPU_CLKS_PROGEND) |
Returns the current clock time difference between CAEPU_CLKS_PROGINIT and CAEPU_CLKS_PROGEND.
Definition at line 966 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_ID | ( | rti, | |
id | |||
) | (CAEPU_IS_CLKS_ID(id)? (rti)->clocks[id]: 0) |
Returns the clock time value for the given id. The id is validated.
Definition at line 924 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_POLL | ( | rti, | |
id | |||
) | CAEPU_RT_CLKS_DIFF(rti, id, CAEPU_CLKS_PROGINCR) |
Returns the current clock time difference between id and CAEPU_CLKS_PROGINCR.
Definition at line 938 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_POLL_STEP | ( | rti | ) | CAEPU_RT_CLKS_POLL(rti, CAEPU_CLKS_BEGSTEP) |
Returns the current clock time difference between CAEPU_CLKS_BEGSTEP and CAEPU_CLKS_PROGINCR.
Definition at line 945 of file apiCAEPUtils.h.
#define CAEPU_RT_CLKS_POLL_TOTAL | ( | rti | ) | CAEPU_RT_CLKS_POLL(rti, CAEPU_CLKS_PROGINIT) |
Returns the current clock time difference between CAEPU_CLKS_PROGINIT and CAEPU_CLKS_PROGINCR.
Definition at line 959 of file apiCAEPUtils.h.
#define CAEPU_RT_DIM | ( | rti | ) | (rti)->pWriteInfo->dimension |
Get the export dimension from CAEP_RTITEM data pointed to by rti.
Definition at line 772 of file apiCAEPUtils.h.
#define CAEPU_RT_DIM_2D | ( | rti | ) | CAEPU_RT_DIM_IS(rti, PWP_DIMENSION_2D) |
Returns PWP_TRUE if export dimension is PWP_DIMENSION_2D.
Definition at line 794 of file apiCAEPUtils.h.
#define CAEPU_RT_DIM_3D | ( | rti | ) | CAEPU_RT_DIM_IS(rti, PWP_DIMENSION_3D) |
Returns PWP_TRUE if export dimension is PWP_DIMENSION_3D.
Definition at line 789 of file apiCAEPUtils.h.
#define CAEPU_RT_DIM_IS | ( | rti, | |
d | |||
) | PWP_CAST_BOOL((d) == CAEPU_RT_DIM(rti)) |
Returns PWP_TRUE if export dimension is d.
Definition at line 784 of file apiCAEPUtils.h.
#define CAEPU_RT_DIM_TEXT | ( | rti | ) | caeuDimensionToText((rti)->pWriteInfo->dimension) |
Get the export dimension text from CAEP_RTITEM data pointed to by rti.
Definition at line 778 of file apiCAEPUtils.h.
#define CAEPU_RT_ENC_ASCII | ( | rti | ) | CAEPU_RT_ENC_IS(rti, PWP_ENCODING_ASCII) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_ASCII.
Definition at line 845 of file apiCAEPUtils.h.
#define CAEPU_RT_ENC_BINARY | ( | rti | ) | CAEPU_RT_ENC_IS(rti, PWP_ENCODING_BINARY) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_BINARY.
Definition at line 850 of file apiCAEPUtils.h.
#define CAEPU_RT_ENC_IS | ( | rti, | |
e | |||
) | PWP_CAST_BOOL((e) == CAEPU_RT_ENCODING(rti)) |
Returns PWP_TRUE if export encoding is enc.
Definition at line 840 of file apiCAEPUtils.h.
#define CAEPU_RT_ENC_UNFORMATTED | ( | rti | ) | CAEPU_RT_ENC_IS(rti, PWP_ENCODING_UNFORMATTED) |
Returns PWP_TRUE if export encoding is PWP_ENCODING_UNFORMATTED.
Definition at line 855 of file apiCAEPUtils.h.
#define CAEPU_RT_ENCODING | ( | rti | ) | (rti)->pWriteInfo->encoding |
Get the export encoding from CAEP_RTITEM data pointed to by rti.
Definition at line 828 of file apiCAEPUtils.h.
#define CAEPU_RT_ENCODING_TEXT | ( | rti | ) | caeuEncodeToText((rti)->pWriteInfo->encoding) |
Get the export precision text from CAEP_RTITEM data pointed to by rti.
Definition at line 834 of file apiCAEPUtils.h.
#define CAEPU_RT_IS_ABORTED | ( | rti | ) | PWP_CAST_BOOL((rti)->opAborted) |
Returns PWP_TRUE if the export has been aborted by the user or the plugin itself.
Definition at line 863 of file apiCAEPUtils.h.
#define CAEPU_RT_PREC | ( | rti | ) | (rti)->pWriteInfo->precision |
Get the export precision from CAEP_RTITEM data pointed to by rti.
Definition at line 800 of file apiCAEPUtils.h.
#define CAEPU_RT_PREC_DOUBLE | ( | rti | ) | CAEPU_RT_PREC_IS(rti, PWP_PRECISION_DOUBLE) |
Returns PWP_TRUE if export dimension is PWP_PRECISION_DOUBLE.
Definition at line 822 of file apiCAEPUtils.h.
#define CAEPU_RT_PREC_IS | ( | rti, | |
prec | |||
) | PWP_CAST_BOOL((prec) == CAEPU_RT_PREC(rti)) |
Returns PWP_TRUE if export precision is prec.
Definition at line 812 of file apiCAEPUtils.h.
#define CAEPU_RT_PREC_SINGLE | ( | rti | ) | CAEPU_RT_PREC_IS(rti, PWP_PRECISION_SINGLE) |
Returns PWP_TRUE if export precision is PWP_PRECISION_SINGLE.
Definition at line 817 of file apiCAEPUtils.h.
#define CAEPU_RT_PREC_TEXT | ( | rti | ) | caeuPrecisionToText((rti)->pWriteInfo->precision) |
Get the export precision text from CAEP_RTITEM data pointed to by rti.
Definition at line 806 of file apiCAEPUtils.h.
#define CAEPU_RT_TRY | ( | rti, | |
theOp | |||
) |
Attempt theOp and abort the export if needed. Returns PWP_FALSE if the export operation is marked as aborted.
The export operation is marked as aborted if and only if theOp returns 0.
Though theOp can be any "boolean" expression, it is typically a function call.
Definition at line 910 of file apiCAEPUtils.h.