Pointwise Plugin SDK
Macros
site.h File Reference

Site Build Configuration Settings. More...

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

Go to the source code of this file.

Macros

#define PWP_SITE_GROUPID   YourGroupIdHere
 Globally unique site identifier 16-bit integer value. More...
 
#define PWP_SITE_GROUPNAME   "YourGroupNameHere"
 Your site's identifier string. More...
 

Detailed Description

Site Build Configuration Settings.

The plugin SDK uses the values in this file to "brand" the binaries built at your site.

Definition in file site.h.

Macro Definition Documentation

◆ PWP_SITE_GROUPID

#define PWP_SITE_GROUPID   YourGroupIdHere

Globally unique site identifier 16-bit integer value.

If you plan on releasing a plugin outside your company, you will need to obtain a PWP_SITE_GROUPID value from Pointwise support. The plugin SDK combines the PWP_SITE_GROUPID value to construct globally unique ids (GUID).

For example, the CAEP_FORMATINFO::id values are initialized in rtCaepInitItems.h using MAKEGUID() as shown in the code below.

/*== CAEP_FORMATINFO FormatInfo */
{ PWP_SITE_GROUPNAME, /* const char *group */
"CaeXxxxx", /* const char *name */
MAKEGUID(ID_CaeXxxxx), /* PWP_UINT32 id */
PWP_FILEDEST_FILENAME, /* PWP_ENUM_FILEDEST fileDest */
Note
Pointwise uses plugin GUIDs at runtime. Pointwise will not be able to load plugins properly at runtime if any id conflicts are detected.
If you do not define a PWP_SITE_GROUPID value, the SDK will default to PWP_GRPID_USER.
See also
MAKEGUID(), apiUtils.h, CAEP_FORMATINFO

Definition at line 94 of file site.h.

◆ PWP_SITE_GROUPNAME

#define PWP_SITE_GROUPNAME   "YourGroupNameHere"

Your site's identifier string.

This string represents the company or group name you want associated with this plugin. For instance, all Pointwise distributed plugins use the group name "Pointwise". The group name is used by the framework to distinguish between similarly named exporters from different authors.

For example, as shown in the list below, the Pointwise application will display a CAE exporter's full name as group/name.

  • Alpha/CGNS
  • Alpha/xml
  • Beta/CGNS
  • Beta/xml

The SDK returns this value in the CAEP_FORMATINFO::group data member as shown in the code below.

/*== CAEP_FORMATINFO FormatInfo */
{ PWP_SITE_GROUPNAME, /* const char *group */
"CaeXxxxx", /* const char *name */
MAKEGUID(ID_CaeXxxxx), /* PWP_UINT32 id */
Note
If you do not define a PWP_SITE_GROUPNAME value, the SDK will default to PWP_GROUPNAME_DEFAULT.
See also
CAEP_FORMATINFO, PwEnumCaeFormat(), PwCaeFormat()

Definition at line 98 of file site.h.