Pointwise Plugin SDK
Classes | Macros | Functions
apiCAEP.h File Reference

Pointwise CAE Plugin API (CAEP-API) More...

#include "apiGridModel.h"
#include "apiPWP.h"
#include "apiPWPUtils.h"
+ Include dependency graph for apiCAEP.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  CAEP_BCINFO
 Boundary condition definition information. More...
 
struct  CAEP_EXPORTER
 CAEP exporter instance handle. More...
 
struct  CAEP_FORMATINFO
 The information returned for each supported CAEP exporter. More...
 
struct  CAEP_VCINFO
 Volume condition definition information. More...
 
struct  CAEP_WRITEINFO
 CAE export write control information. More...
 

Macros

#define CAEP_GROUP_VALUE_DEFNS   PWU_GROUP_VALUE_DEFNS(CAEP_VALUE_GROUP)
 
#define CAEP_GROUP_VALUE_NAMES   PWU_GROUP_VALUE_NAMES(CAEP_VALUE_GROUP)
 
#define CAEP_INFO_GROUP   CAEP_VALUE_GROUP ".INFO"
 
#define CAEP_VALUE_GROUP   "SDK.Plugin.CAE"
 
#define CAEP_ENUM_FILEDEST   PWP_ENUM_FILEDEST
 These CAEP_ENUM macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENUM types instead. More...
 
#define CAEP_ENUM_DIMENSION   PWP_ENUM_DIMENSION
 These CAEP_ENUM macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENUM types instead. More...
 
#define CAEP_ENUM_ENCODING   PWP_ENUM_ENCODING
 These CAEP_ENUM macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENUM types instead. More...
 
#define CAEP_ENUM_PRECISION   PWP_ENUM_PRECISION
 These CAEP_ENUM macros are defined for backward compatibility. Usage is deprecated. Use the PWP_ENUM types instead. More...
 

Functions

PWP_PROTOTYPE_DECL PWP_BOOL PwCaeElementType (CAEP_EXPORTER handle, PWGM_ENUM_ELEMTYPE which)
 Test if CAE exporter instance supports the given element type. More...
 
PWP_PROTOTYPE_DECL const char * PwCaeEnumBCs (CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_BCINFO *pBCInfo)
 Enumerate CAEP_BCINFO data for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL const char * PwCaeEnumFileExt (CAEP_EXPORTER handle, PWP_UINT32 ndx)
 Enumerate supported file extensions for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL const char * PwCaeEnumVCs (CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_VCINFO *pVCInfo)
 Enumerate CAEP_VCINFO data for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL const char * PwCaeFormat (CAEP_EXPORTER handle, CAEP_FORMATINFO *pFormatInfo)
 Get CAEP_FORMATINFO data for a CAE exporter handle. More...
 
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetBCCount (CAEP_EXPORTER handle)
 Get the number of BC's for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetFileExtCount (CAEP_EXPORTER handle)
 Get the number of supported file extensions for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetVCCount (CAEP_EXPORTER handle)
 Get the number of VC's for a CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL PWP_BOOL PwCaeGridWrite (CAEP_EXPORTER handle, PWGM_HGRIDMODEL model, const CAEP_WRITEINFO *pWriteInfo)
 Initiates writing a grid model. More...
 
PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeById (PWP_UINT32 id)
 Create CAE exporter instance with given id. More...
 
PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeByName (const char name[])
 Create CAE exporter instance with given name. More...
 
PWP_PROTOTYPE_DECL PWP_VOID PwDestroyCae (CAEP_EXPORTER *handle)
 Destroy CAE exporter instance. More...
 
PWP_PROTOTYPE_DECL const char * PwEnumCaeFormat (PWP_UINT32 ndx, CAEP_FORMATINFO *pFormatInfo)
 Enumerate CAEP_FORMATINFO data for all supported CAE exporters. More...
 
PWP_PROTOTYPE_DECL PWP_UINT32 PwGetCaeFormatCount ()
 Get the number of supported CAE exporters. More...
 

Detailed Description

Pointwise CAE Plugin API (CAEP-API)

This defines the API extension required for all Pointwise CAE plugins.

Definition in file apiCAEP.h.