Pointwise CAE Plugin SDK
Classes | Enumerations | Variables
+ Collaboration diagram for CAEP-API/SDK Data Types and Instances:

Classes

struct  CAEP_RTITEM
 The data representing a CAE exporter instance. More...
 

Enumerations

enum  CAEPU_ENUM_CLOCKS {
  CAEPU_CLKS_PROGUPDATE,
  CAEPU_CLKS_PROGINIT,
  CAEPU_CLKS_BEGSTEP,
  CAEPU_CLKS_PROGINCR,
  CAEPU_CLKS_ENDSTEP,
  CAEPU_CLKS_PROGEND
}
 Supported CAEPU clock id values. More...
 

Variables

CAEP_RTITEM caepRtItem []
 The runtime array of CAEP_RTITEM items. More...
 
PWP_UINT32 caepFormatCnt
 The number of entries in caepRtItem[] array. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ CAEPU_ENUM_CLOCKS

Supported CAEPU clock id values.

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

All times are initialized to 0.

See also
CAEPU_IS_CLKS_ID, CAEPU_RT_CLKS_ID, CAEPU_RT_CLKS_DIFF, CAEPU_RT_CLKS_POLL, CAEPU_RT_CLKS_POLL_STEP, CAEPU_RT_CLKS_DIFF_STEP, CAEPU_RT_CLKS_POLL_TOTAL, CAEPU_RT_CLKS_DIFF_TOTAL, CAEPU_CLKS_TO_MSECS, CAEPU_CLKS_TO_SECS, CAEPU_CLKS_TO_MINS, CAEPU_CLKS_TO_HOURS, CAEPU_CLKS_TO_FSECS, CAEP_RTITEM::clocks
Enumerator
CAEPU_CLKS_PROGUPDATE 

last time a progress update msg was sent

CAEPU_CLKS_PROGINIT 

time caeuProgressInit() was called

CAEPU_CLKS_BEGSTEP 

time caeuProgressBeginStep() was called

CAEPU_CLKS_PROGINCR 

time caeuProgressIncr() was called

CAEPU_CLKS_ENDSTEP 

time caeuProgressEndStep() was called

CAEPU_CLKS_PROGEND 

time caeuProgressEnd() was called

Definition at line 104 of file apiCAEPUtils.h.

Variable Documentation

◆ caepFormatCnt

PWP_UINT32 caepFormatCnt

The number of entries in caepRtItem[] array.

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

Definition at line 37 of file apiCAEP.cxx.

Referenced by caeuFindFormatById(), caeuFindFormatByName(), PwEnumCaeFormat(), and PwGetCaeFormatCount().

◆ caepRtItem

CAEP_RTITEM caepRtItem[]

The runtime array of CAEP_RTITEM items.

This array is initialized in apiCAEP.cxx by including the plugin-defined data from the rtCaepSupportData.h and rtCaepInitItems.h header files.

There will be one entry in this array for each CAE Exporter supported by the plugin.

The items in this array are used to generate CAEP_FORMATINFO values for PwEnumCaeFormat() and PwCaeFormat().

See also
PwEnumCaeFormat(), PwCaeFormat(), CAEP_FORMATINFO

Definition at line 31 of file apiCAEP.cxx.

Referenced by caeuFindFormatById(), caeuFindFormatByName(), and caeuH2Rti().