Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apiCAEP.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Pointwise CAE Plugin API (CAE-API) v1.0
4  *
5  * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
6  *
7  ***************************************************************************/
8 
9 #ifndef _APICAE_H_
10 #define _APICAE_H_
11 
12 #include "apiGridModel.h"
13 #include "apiPWP.h"
14 #include "apiPWPUtils.h"
15 
16 
17 extern "C" {
18 
19 
27 /***********************************************************/
28 /***********************************************************/
49 #define CAEP_VALUE_GROUP "SDK.Plugin.CAE"
50 #define CAEP_GROUP_VALUE_NAMES PWU_GROUP_VALUE_NAMES(CAEP_VALUE_GROUP)
51 #define CAEP_GROUP_VALUE_DEFNS PWU_GROUP_VALUE_DEFNS(CAEP_VALUE_GROUP)
52 
53 #define CAEP_INFO_GROUP CAEP_VALUE_GROUP ".INFO"
54 
55 
56 /***********************************************************/
57 /***********************************************************/
62 /*---------------------------------------------------------*/
67 struct CAEP_BCINFO {
70  const char *phystype;
71 
75 };
76 
77 
78 //--------------------------------------------
83 #define CAEP_ENUM_FILEDEST PWP_ENUM_FILEDEST
84 #define CAEP_ENUM_DIMENSION PWP_ENUM_DIMENSION
85 #define CAEP_ENUM_ENCODING PWP_ENUM_ENCODING
86 #define CAEP_ENUM_PRECISION PWP_ENUM_PRECISION
87 
90 /*---------------------------------------------------------*/
103  const char *group;
104 
107  const char *name;
108 
112 
122 
126 
130 
134 
138 
142 
146 
150 
154 
158 };
159 
160 
161 /*---------------------------------------------------------*/
166 struct CAEP_VCINFO {
169  const char *phystype;
170 
174 };
175 
176 
177 /*---------------------------------------------------------*/
187  const char *fileDest;
188 
192 
196 
200 
204 
208 };
209 
210 /*---------------------------------------------------------*/
220  /* DOXGRP_APICAEP_TYPES */
222 
223 
224 /***********************************************************/
225 /***********************************************************/
230 /*---------------------------------------------------------*/
243 PWP_PROTOTYPE_DECL CAEP_EXPORTER
245 
246 /*---------------------------------------------------------*/
257 PWP_PROTOTYPE_DECL CAEP_EXPORTER
258 PwCreateCaeByName(const char name[]);
259 
260 /*---------------------------------------------------------*/
269 PWP_PROTOTYPE_DECL PWP_VOID
270 PwDestroyCae(CAEP_EXPORTER *handle);
271 
272 /*---------------------------------------------------------*/
293 PWP_PROTOTYPE_DECL const char*
294 PwEnumCaeFormat(PWP_UINT32 ndx, CAEP_FORMATINFO *pFormatInfo);
295 
296 /*---------------------------------------------------------*/
301 PWP_PROTOTYPE_DECL PWP_UINT32
303 
304 /*---------------------------------------------------------*/
327 PWP_PROTOTYPE_DECL const char*
328 PwCaeFormat(CAEP_EXPORTER handle, CAEP_FORMATINFO *pFormatInfo);
329 
330 /*---------------------------------------------------------*/
342 PWP_PROTOTYPE_DECL PWP_BOOL
344 
345 /*---------------------------------------------------------*/
361 PWP_PROTOTYPE_DECL const char*
362 PwCaeEnumBCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_BCINFO *pBCInfo);
363 
364 /*---------------------------------------------------------*/
376 PWP_PROTOTYPE_DECL const char*
378 
379 /*---------------------------------------------------------*/
395 PWP_PROTOTYPE_DECL const char*
396 PwCaeEnumVCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_VCINFO *pVCInfo);
397 
398 /*---------------------------------------------------------*/
407 PWP_PROTOTYPE_DECL PWP_UINT32
409 
410 /*---------------------------------------------------------*/
420 PWP_PROTOTYPE_DECL PWP_UINT32
422 
423 /*---------------------------------------------------------*/
432 PWP_PROTOTYPE_DECL PWP_UINT32
434 
435 /*---------------------------------------------------------*/
456 PWP_PROTOTYPE_DECL PWP_BOOL
458  const CAEP_WRITEINFO *pWriteInfo);
459 
464 } /* extern "C" */
465 
466 #endif /* !_APICAE_H_ */
PWP_BOOL conditionsOnly
Set to PWP_TRUE if only Conditions exported.
Definition: apiCAEP.h:191
PWP_BOOL allowedDataPrecisionDouble
Set to PWP_TRUE if double precision data supported in export.
Definition: apiCAEP.h:149
PWP_BOOL allowedDimension2D
Set to PWP_TRUE if 2D exports supported.
Definition: apiCAEP.h:153
CAEP_EXPORTER PwCreateCaeById(PWP_UINT32 id)
Create CAE exporter instance with given id.
Definition: apiCAEP.cxx:92
PWP_ENUM_ENCODING encoding
export file encoding.
Definition: apiCAEP.h:195
unsigned int PWP_UINT32
32-bit unsigned integer
Definition: apiPWP.h:210
const char * PwCaeEnumVCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_VCINFO *pVCInfo)
Enumerate CAEP_VCINFO data for a CAE exporter instance.
Definition: apiCAEP.cxx:207
Pointwise Plugin API (PWP-API)
const char * PwCaeFormat(CAEP_EXPORTER handle, CAEP_FORMATINFO *pFormatInfo)
Get CAEP_FORMATINFO data for a CAE exporter handle.
Definition: apiCAEP.cxx:145
void PWP_VOID
no value
Definition: apiPWP.h:317
The information returned for each supported CAEP exporter.
Definition: apiCAEP.h:98
PWP_UINT32 PwCaeGetFileExtCount(CAEP_EXPORTER handle)
Get the number of supported file extensions for a CAE exporter instance.
Definition: apiCAEP.cxx:234
PWP_BOOL allowedFileFormatBinary
Set to PWP_TRUE if Binary files supported in export.
Definition: apiCAEP.h:137
const char * PwCaeEnumFileExt(CAEP_EXPORTER handle, PWP_UINT32 ndx)
Enumerate supported file extensions for a CAE exporter instance.
Definition: apiCAEP.cxx:197
Pointwise Grid Model API Specification (PWGM-API)
PWP_BOOL allowedVolumeConditions
Set to PWP_TRUE if VCs are supported.
Definition: apiCAEP.h:129
PWP_ENUM_PRECISION
File precision values.
Definition: apiPWP.h:802
const char * group
The plugin's group name.
Definition: apiCAEP.h:103
PWP_UINT32 PwCaeGetBCCount(CAEP_EXPORTER handle)
Get the number of BC's for a CAE exporter instance.
Definition: apiCAEP.cxx:222
#define PWP_DECLARE_HANDLE(name)
Declares a root-level, strongly-typed data handle type.
Definition: apiPWP.h:340
PWP_INT32 id
BC physical type id.
Definition: apiCAEP.h:74
PWP_UINT32 id
VC physical type id.
Definition: apiCAEP.h:173
const char * phystype
BC physical type name.
Definition: apiCAEP.h:70
PWP_BOOL allowedDataPrecisionSingle
Set to PWP_TRUE if single precision data supported in export.
Definition: apiCAEP.h:145
const char * fileDest
requested file destination.
Definition: apiCAEP.h:187
const char * PwCaeEnumBCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_BCINFO *pBCInfo)
Enumerate CAEP_BCINFO data for a CAE exporter instance.
Definition: apiCAEP.cxx:182
PWP_BOOL allowedDimension3D
Set to PWP_TRUE if 3D exports supported.
Definition: apiCAEP.h:157
const char * name
format Name.
Definition: apiCAEP.h:107
PWP_VOID PwDestroyCae(CAEP_EXPORTER *handle)
Destroy CAE exporter instance.
Definition: apiCAEP.cxx:114
PWP_BOOL allowedFileFormatUnformatted
Set to PWP_TRUE if Unformatted files supported in export.
Definition: apiCAEP.h:141
PWP_BOOL PwCaeElementType(CAEP_EXPORTER handle, PWGM_ENUM_ELEMTYPE which)
Test if CAE exporter instance supports the given element type.
Definition: apiCAEP.cxx:157
PWGM_ENUM_ELEMTYPE
Element type ids.
Definition: apiGridModel.h:672
PWP_UINT32 PwCaeGetVCCount(CAEP_EXPORTER handle)
Get the number of VC's for a CAE exporter instance.
Definition: apiCAEP.cxx:246
Volume condition definition information.
Definition: apiCAEP.h:166
const char * phystype
VC physical type name.
Definition: apiCAEP.h:169
PWP_ENUM_DIMENSION
Supported dimensionality values.
Definition: apiPWP.h:763
PWP_BOOL PwCaeGridWrite(CAEP_EXPORTER handle, PWGM_HGRIDMODEL model, const CAEP_WRITEINFO *pWriteInfo)
Initiates writing a grid model.
Definition: apiCAEP.cxx:258
int PWP_BOOL
logical value
Definition: apiPWP.h:303
PWP_ENUM_ENCODING
File encoding values.
Definition: apiPWP.h:782
CAE export write control information.
Definition: apiCAEP.h:184
PWP_UINT32 PwGetCaeFormatCount()
Get the number of supported CAE exporters.
Definition: apiCAEP.cxx:138
Boundary condition definition information.
Definition: apiCAEP.h:67
const char * PwEnumCaeFormat(PWP_UINT32 ndx, CAEP_FORMATINFO *pFormatInfo)
Enumerate CAEP_FORMATINFO data for all supported CAE exporters.
Definition: apiCAEP.cxx:127
PWP_UINT32 id
format guid.
Definition: apiCAEP.h:111
PWP_ENUM_DIMENSION dimension
export dimensionality.
Definition: apiCAEP.h:203
PWP_ENDIANNESS byteOrder
export byte order.
Definition: apiCAEP.h:207
PWP_ENUM_FILEDEST
File destination types.
Definition: apiPWP.h:743
PWP_ENDIANNESS
Flags used to indicate endianness or control endian behaviors in functions.
Definition: apiPWP.h:822
PWP_ENUM_PRECISION precision
export precision.
Definition: apiCAEP.h:199
PWP_ENUM_FILEDEST fileDest
Specifies the desired output destination type.
Definition: apiCAEP.h:121
PWP_BOOL allowedFileFormatASCII
Set to PWP_TRUE if ASCII files supported in export.
Definition: apiCAEP.h:133
An opaque handle to a grid model.
Definition: apiGridModel.h:326
CAEP exporter instance handle.
Definition: apiCAEP.h:219
CAEP_EXPORTER PwCreateCaeByName(const char name[])
Create CAE exporter instance with given name.
Definition: apiCAEP.cxx:103
int PWP_INT32
32-bit integer
Definition: apiPWP.h:207
PWP_BOOL allowedExportConditionsOnly
Set to PWP_TRUE if separate Condition export supported.
Definition: apiCAEP.h:125
Data and functions useful to PWP-API compliant plugins.