Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Classes | Enumerations | Variables
GRDP-API/SDK Data Types and Instances
+ Collaboration diagram for GRDP-API/SDK Data Types and Instances:

Classes

struct  GRDP_RTITEM
 The data representing a grid importer instance. More...
 

Enumerations

enum  GRDP_ENUM_CLOCKS {
  GRDP_CLKS_PROGUPDATE,
  GRDP_CLKS_PROGINIT,
  GRDP_CLKS_BEGSTEP,
  GRDP_CLKS_PROGINCR,
  GRDP_CLKS_ENDSTEP,
  GRDP_CLKS_PROGEND
}
 Supported GRDP clock id values. More...
 

Variables

PWP_UINT32 grdpFormatCnt
 The number of entries in grdpRtItem[] array. More...
 
GRDP_RTITEM grdpRtItem []
 The runtime array of GRDP_RTITEM items. More...
 

Detailed Description

The SDK data types and instances that implement the GRDP-API.

Enumeration Type Documentation

Supported GRDP clock id values.

A collection of timer values that can be used for measuring import timings. Typically, these values are used for debugging and performance purposes.

All times are initialized to 0.

See Also
GRDP_IS_CLKS_ID, GRDP_RT_CLKS_ID, GRDP_RT_CLKS_DIFF, GRDP_RT_CLKS_POLL, GRDP_RT_CLKS_POLL_STEP, GRDP_RT_CLKS_DIFF_STEP, GRDP_RT_CLKS_POLL_TOTAL, GRDP_RT_CLKS_DIFF_TOTAL, GRDP_CLKS_TO_MSECS, GRDP_CLKS_TO_SECS, GRDP_CLKS_TO_MINS, GRDP_CLKS_TO_HOURS, GRDP_CLKS_TO_FSECS, GRDP_RTITEM::clocks
Enumerator
GRDP_CLKS_PROGUPDATE 

last time a progress update msg was sent

GRDP_CLKS_PROGINIT 

time grdpProgressInit() was called

GRDP_CLKS_BEGSTEP 

time grdpProgressBeginStep() was called

GRDP_CLKS_PROGINCR 

time grdpProgressIncr() was called

GRDP_CLKS_ENDSTEP 

time grdpProgressEndStep() was called

GRDP_CLKS_PROGEND 

time grdpProgressEnd() was called

Definition at line 95 of file apiGRDPUtils.h.

Variable Documentation

PWP_UINT32 grdpFormatCnt

The number of entries in grdpRtItem[] array.

Accessed by the low-level API call PwGetGrdpFormatCount(). This value MUST be 1 or greater.

Definition at line 33 of file apiGRDP.cxx.

Referenced by grdpFindFormatById(), grdpFindFormatByName(), PwEnumGrdpFormat(), and PwGetGrdpFormatCount().

GRDP_RTITEM grdpRtItem[]

The runtime array of GRDP_RTITEM items.

This array is initialized in apiGRDP.cxx by including the plugin-defined data from the rtGrdpSupportData.h and rtGrdpInitItems.h header files.

There will be one entry in this array for each grid importer supported by the plugin.

The items in this array are used to generate GRDP_FORMATINFO values for PwEnumGrdpFormat() and PwGrdpFormat().

See Also
PwEnumGrdpFormat(), PwGrdpFormat(), GRDP_FORMATINFO

Definition at line 27 of file apiGRDP.cxx.

Referenced by grdpFindFormatById(), grdpFindFormatByName(), and grdpH2Rti().