Pointwise Plugin SDK
Functions
+ Collaboration diagram for API Functions:

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

Function Documentation

◆ PwCaeElementType()

PWP_PROTOTYPE_DECL PWP_BOOL PwCaeElementType ( CAEP_EXPORTER  handle,
PWGM_ENUM_ELEMTYPE  which 
)

Test if CAE exporter instance supports the given element type.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
whichThe PWGM_ENUM_ELEMTYPE to test.
Returns
PWP_TRUE if element type which is supported.

Definition at line 159 of file apiCAEP.cxx.

References caeuH2Rti(), CAEP_RTITEM::elemType, PWGM_ELEMTYPE_BAR, PWGM_ELEMTYPE_HEX, PWGM_ELEMTYPE_POINT, PWGM_ELEMTYPE_PYRAMID, PWGM_ELEMTYPE_QUAD, PWGM_ELEMTYPE_TET, PWGM_ELEMTYPE_TRI, PWGM_ELEMTYPE_WEDGE, and PWP_FALSE.

◆ PwCaeEnumBCs()

PWP_PROTOTYPE_DECL const char* PwCaeEnumBCs ( CAEP_EXPORTER  handle,
PWP_UINT32  ndx,
CAEP_BCINFO pBCInfo 
)

Enumerate CAEP_BCINFO data for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
ndxThe BC index starting with 0.
pBCInfoPointer to a CAEP_BCINFO buffer.
Returns
The BC name (same as pBCInfo->phystype). NULL if handle or ndx is not valid.

Definition at line 184 of file apiCAEP.cxx.

References CAEP_RTITEM::BCCnt, caeuH2Rti(), CAEP_RTITEM::pBCInfo, and CAEP_BCINFO::phystype.

◆ PwCaeEnumFileExt()

PWP_PROTOTYPE_DECL const char* PwCaeEnumFileExt ( CAEP_EXPORTER  handle,
PWP_UINT32  ndx 
)

Enumerate supported file extensions for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
ndxThe file extension index starting with 0.
Returns
file extension or null if handle or ndx is invalid.

Definition at line 199 of file apiCAEP.cxx.

References caeuH2Rti(), CAEP_RTITEM::ExtCnt, and CAEP_RTITEM::pFileExt.

◆ PwCaeEnumVCs()

PWP_PROTOTYPE_DECL const char* PwCaeEnumVCs ( CAEP_EXPORTER  handle,
PWP_UINT32  ndx,
CAEP_VCINFO pVCInfo 
)

Enumerate CAEP_VCINFO data for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
ndxThe VC index starting with 0.
pVCInfoPointer to a CAEP_VCINFO buffer.
Returns
The VC name (same as pVCInfo->phystype). NULL if handle or ndx is not valid.

Definition at line 209 of file apiCAEP.cxx.

References CAEP_FORMATINFO::allowedVolumeConditions, caeuH2Rti(), CAEP_RTITEM::FormatInfo, CAEP_VCINFO::phystype, CAEP_RTITEM::pVCInfo, and CAEP_RTITEM::VCCnt.

◆ PwCaeFormat()

PWP_PROTOTYPE_DECL const char* PwCaeFormat ( CAEP_EXPORTER  handle,
CAEP_FORMATINFO pFormatInfo 
)

Get CAEP_FORMATINFO data for a CAE exporter handle.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
pFormatInfoPointer to a CAEP_FORMATINFO buffer.
Returns
The CAE format name (same as info.name). NULL if ndx is not valid.
See also
PwCaeFormat()
Sample usage:
if (caep->PwCaeFormat(h, &info)) {
...do something here...
}

Definition at line 147 of file apiCAEP.cxx.

References caeuH2Rti(), CAEP_RTITEM::FormatInfo, and CAEP_FORMATINFO::name.

◆ PwCaeGetBCCount()

PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetBCCount ( CAEP_EXPORTER  handle)

Get the number of BC's for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
Returns
number of BC's

Definition at line 224 of file apiCAEP.cxx.

References CAEP_RTITEM::BCCnt, and caeuH2Rti().

◆ PwCaeGetFileExtCount()

PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetFileExtCount ( CAEP_EXPORTER  handle)

Get the number of supported file extensions for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
Returns
number of file extensions

Definition at line 236 of file apiCAEP.cxx.

References caeuH2Rti(), and CAEP_RTITEM::ExtCnt.

◆ PwCaeGetVCCount()

PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetVCCount ( CAEP_EXPORTER  handle)

Get the number of VC's for a CAE exporter instance.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
Returns
number of VC's

Definition at line 248 of file apiCAEP.cxx.

References CAEP_FORMATINFO::allowedVolumeConditions, caeuH2Rti(), CAEP_RTITEM::FormatInfo, and CAEP_RTITEM::VCCnt.

◆ PwCaeGridWrite()

PWP_PROTOTYPE_DECL PWP_BOOL PwCaeGridWrite ( CAEP_EXPORTER  handle,
PWGM_HGRIDMODEL  model,
const CAEP_WRITEINFO pWriteInfo 
)

Initiates writing a grid model.

Instructs a plugin to write the given grid model according to the specified CAEP_WRITEINFO settings.

Parameters
handleA CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
modelA PWGM_HGRIDMODEL handle. The plugin uses this handle to access the grid model data.
pWriteInfoPointer to a CAEP_WRITEINFO settings buffer.
Returns
PWP_FALSE if write failed.
See also
PWGM-API specification

Definition at line 260 of file apiCAEP.cxx.

References caeuFileClose(), caeuFileOpen(), caeuH2Rti(), CAEP_RTITEM::model, PWP_FALSE, PWP_TRUE, pwpCwdPop(), CAEP_RTITEM::pWriteInfo, and runtimeWrite().

◆ PwCreateCaeById()

PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeById ( PWP_UINT32  id)

Create CAE exporter instance with given id.

Parameters
idThe plugin-defined CAE exporter id.
Returns
The CAE exporter handle or NULL if id is invalid.
See also
PwEnumCaeFormat()
Note
Valid CAE exporter id's can be obtained from PwEnumCaeFormat(pFormatInfo).

Definition at line 94 of file apiCAEP.cxx.

References caepRuntimeCreate(), and caeuFindFormatById().

◆ PwCreateCaeByName()

PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeByName ( const char  name[])

Create CAE exporter instance with given name.

Parameters
nameThe plugin-defined CAE exporter name.
Returns
The CAE exporter handle or NULL if name is invalid.
See also
PwEnumCaeFormat()
Note
Valid CAE exporter names can be obtained from PwEnumCaeFormat(pFormatInfo).

Definition at line 105 of file apiCAEP.cxx.

References caepRuntimeCreate(), and caeuFindFormatByName().

◆ PwDestroyCae()

PWP_PROTOTYPE_DECL PWP_VOID PwDestroyCae ( CAEP_EXPORTER handle)

Destroy CAE exporter instance.

Parameters
handlePointer to a CAEP_EXPORTER handle obtained from PwCreateCaeById() or PwCreateCaeByName().
See also
PwCreateCaeByName(), PwCreateCaeById()

Definition at line 116 of file apiCAEP.cxx.

References caepRuntimeDestroy(), and caeuH2Rti().

◆ PwEnumCaeFormat()

PWP_PROTOTYPE_DECL const char* PwEnumCaeFormat ( PWP_UINT32  ndx,
CAEP_FORMATINFO pFormatInfo 
)

Enumerate CAEP_FORMATINFO data for all supported CAE exporters.

Parameters
ndxThe format index starting with 0.
pFormatInfoPointer to a CAEP_FORMATINFO buffer.
Returns
The CAE format name (same as info.name). NULL if ndx is not valid.
See also
PwCaeFormat()
Sample usage:
PWP_UINT32 ndx = 0;
while (caep->PwEnumCaeFormat(ndx++, &info)) {
...do something here...
}

Definition at line 129 of file apiCAEP.cxx.

References caepFormatCnt, caepRtItem, and CAEP_RTITEM::FormatInfo.

◆ PwGetCaeFormatCount()

PWP_PROTOTYPE_DECL PWP_UINT32 PwGetCaeFormatCount ( )

Get the number of supported CAE exporters.

Returns
The number of supported exporters.

Definition at line 140 of file apiCAEP.cxx.

References caepFormatCnt.