Pointwise CAE Plugin SDK
Macros
rtPwpInitItems.h File Reference

Static Initialization Data for the PWU_RTITEM Array. More...

+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define _RTPWPINITITEMS_H_
 

Detailed Description

Static Initialization Data for the PWU_RTITEM Array.

The file rtPwpInitItems.h defines the static, compile-time initialization of the global PWU_RTITEM pwpRtItem[] array. The PWP Plugin SDK uses this array to implement the functions and behaviors required by the Pointwise Plugin API Specification (PWP-API). If you want to see the SDK implementation details, look in the /shared/PWP/apiPWP.cxx file.

The SDK file /shared/PWP/apiPWP.cxx includes rtPwpInitItems.h as shown below.

// include the impl-defined PWP runtime item array data
#include "rtPwpInitItems.h"
// special items NOT returned bt PwpEnumAPIs() - always LAST!
/*............................*/
{
0,
},
/*............................*/
{
0,
},
};

A valid plugin will have a minimum of 2 PWU_RTITEM array items. One entry identifies the supported PWP-API version. The other entry identifies an additional supported plugin API specification. See Supported Plugin API Basenames for a list of the supported APIs.

The format of rtPwpInitItems.h must be valid for the static initialization of an array of C-struct's. It is important to note that some of PWU_RTITEM's data members are also structs. This will require curly-braces {} around these nested data members. If you are not familiar with static initialization, see the Example C-struct Static Initialization page.

When copied from the src/plugins/templates/PWP/ folder to your plugins project folder, rtPwpInitItems.h will contain example initilization data for 2 PWU_RTITEM array items. This example data must be culled and edited to define the settings appropriate for your plugin's implementation.

The example data from the SDK rtPwpInitItems.h template file is shown below. It specifies that the "Plugin-PWP/1.0" API specification is supported along with the "Export-CAE/1.0" API specification.

/*............................*/
{
0,
},
/*............................*/
{
{CAEP_API_EXPORT "/1.0", {1,0}},
},

Definition in file rtPwpInitItems.h.

Macro Definition Documentation

◆ _RTPWPINITITEMS_H_

#define _RTPWPINITITEMS_H_