Pointwise Plugin SDK
apiCAEP.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Pointwise CAE Plugin API (CAE-API) v1.0
4  *
5  * Proprietary software product of Pointwise, Inc.
6  * Copyright (c) 1995-2018 Pointwise, Inc.
7  * All rights reserved.
8  *
9  ***************************************************************************/
10 
11 #ifndef _APICAE_H_
12 #define _APICAE_H_
13 
14 #include "apiGridModel.h"
15 #include "apiPWP.h"
16 #include "apiPWPUtils.h"
17 
18 
19 extern "C" {
20 
21 
29 /***********************************************************/
30 /***********************************************************/
51 #define CAEP_VALUE_GROUP "SDK.Plugin.CAE"
52 #define CAEP_GROUP_VALUE_NAMES PWU_GROUP_VALUE_NAMES(CAEP_VALUE_GROUP)
53 #define CAEP_GROUP_VALUE_DEFNS PWU_GROUP_VALUE_DEFNS(CAEP_VALUE_GROUP)
54 
55 #define CAEP_INFO_GROUP CAEP_VALUE_GROUP ".INFO"
56 
57 
58 /***********************************************************/
59 /***********************************************************/
64 /*---------------------------------------------------------*/
69 struct CAEP_BCINFO {
72  const char *phystype;
73 
77 };
78 
79 
80 //--------------------------------------------
85 #define CAEP_ENUM_FILEDEST PWP_ENUM_FILEDEST
86 #define CAEP_ENUM_DIMENSION PWP_ENUM_DIMENSION
87 #define CAEP_ENUM_ENCODING PWP_ENUM_ENCODING
88 #define CAEP_ENUM_PRECISION PWP_ENUM_PRECISION
89 
92 /*---------------------------------------------------------*/
105  const char *group;
106 
109  const char *name;
110 
114 
124 
128 
132 
136 
140 
144 
148 
152 
156 
160 };
161 
162 
163 /*---------------------------------------------------------*/
168 struct CAEP_VCINFO {
171  const char *phystype;
172 
176 };
177 
178 
179 /*---------------------------------------------------------*/
189  const char *fileDest;
190 
194 
198 
202 
206 
210 };
211 
212 /*---------------------------------------------------------*/
222  /* DOXGRP_APICAEP_TYPES */
224 
225 
226 /***********************************************************/
227 /***********************************************************/
232 /*---------------------------------------------------------*/
245 PWP_PROTOTYPE_DECL CAEP_EXPORTER
247 
248 /*---------------------------------------------------------*/
259 PWP_PROTOTYPE_DECL CAEP_EXPORTER
260 PwCreateCaeByName(const char name[]);
261 
262 /*---------------------------------------------------------*/
271 PWP_PROTOTYPE_DECL PWP_VOID
272 PwDestroyCae(CAEP_EXPORTER *handle);
273 
274 /*---------------------------------------------------------*/
295 PWP_PROTOTYPE_DECL const char*
296 PwEnumCaeFormat(PWP_UINT32 ndx, CAEP_FORMATINFO *pFormatInfo);
297 
298 /*---------------------------------------------------------*/
303 PWP_PROTOTYPE_DECL PWP_UINT32
305 
306 /*---------------------------------------------------------*/
329 PWP_PROTOTYPE_DECL const char*
330 PwCaeFormat(CAEP_EXPORTER handle, CAEP_FORMATINFO *pFormatInfo);
331 
332 /*---------------------------------------------------------*/
344 PWP_PROTOTYPE_DECL PWP_BOOL
346 
347 /*---------------------------------------------------------*/
363 PWP_PROTOTYPE_DECL const char*
364 PwCaeEnumBCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_BCINFO *pBCInfo);
365 
366 /*---------------------------------------------------------*/
378 PWP_PROTOTYPE_DECL const char*
380 
381 /*---------------------------------------------------------*/
397 PWP_PROTOTYPE_DECL const char*
398 PwCaeEnumVCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_VCINFO *pVCInfo);
399 
400 /*---------------------------------------------------------*/
409 PWP_PROTOTYPE_DECL PWP_UINT32
411 
412 /*---------------------------------------------------------*/
422 PWP_PROTOTYPE_DECL PWP_UINT32
424 
425 /*---------------------------------------------------------*/
434 PWP_PROTOTYPE_DECL PWP_UINT32
436 
437 /*---------------------------------------------------------*/
458 PWP_PROTOTYPE_DECL PWP_BOOL
460  const CAEP_WRITEINFO *pWriteInfo);
461 
466 } /* extern "C" */
467 
468 #endif /* !_APICAE_H_ */
PWP_BOOL conditionsOnly
Set to PWP_TRUE if only Conditions exported.
Definition: apiCAEP.h:193
PWP_BOOL allowedDataPrecisionDouble
Set to PWP_TRUE if double precision data supported in export.
Definition: apiCAEP.h:151
PWP_BOOL allowedDimension2D
Set to PWP_TRUE if 2D exports supported.
Definition: apiCAEP.h:155
PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeById(PWP_UINT32 id)
Create CAE exporter instance with given id.
Definition: apiCAEP.cxx:94
PWP_ENUM_ENCODING encoding
export file encoding.
Definition: apiCAEP.h:197
unsigned int PWP_UINT32
32-bit unsigned integer
Definition: apiPWP.h:194
PWP_PROTOTYPE_DECL const char * PwCaeEnumVCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_VCINFO *pVCInfo)
Enumerate CAEP_VCINFO data for a CAE exporter instance.
Definition: apiCAEP.cxx:209
Pointwise Plugin API (PWP-API)
PWP_PROTOTYPE_DECL const char * PwCaeFormat(CAEP_EXPORTER handle, CAEP_FORMATINFO *pFormatInfo)
Get CAEP_FORMATINFO data for a CAE exporter handle.
Definition: apiCAEP.cxx:147
void PWP_VOID
no value
Definition: apiPWP.h:233
The information returned for each supported CAEP exporter.
Definition: apiCAEP.h:100
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetFileExtCount(CAEP_EXPORTER handle)
Get the number of supported file extensions for a CAE exporter instance.
Definition: apiCAEP.cxx:236
PWP_BOOL allowedFileFormatBinary
Set to PWP_TRUE if Binary files supported in export.
Definition: apiCAEP.h:139
PWP_PROTOTYPE_DECL const char * PwCaeEnumFileExt(CAEP_EXPORTER handle, PWP_UINT32 ndx)
Enumerate supported file extensions for a CAE exporter instance.
Definition: apiCAEP.cxx:199
Pointwise Grid Model API Specification (PWGM-API)
PWP_BOOL allowedVolumeConditions
Set to PWP_TRUE if VCs are supported.
Definition: apiCAEP.h:131
PWP_ENUM_PRECISION
File precision values.
Definition: apiPWP.h:718
const char * group
The plugin's group name.
Definition: apiCAEP.h:105
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetBCCount(CAEP_EXPORTER handle)
Get the number of BC's for a CAE exporter instance.
Definition: apiCAEP.cxx:224
#define PWP_DECLARE_HANDLE(name)
Declares a root-level, strongly-typed data handle type.
Definition: apiPWP.h:256
PWP_INT32 id
BC physical type id.
Definition: apiCAEP.h:76
PWP_UINT32 id
VC physical type id.
Definition: apiCAEP.h:175
const char * phystype
BC physical type name.
Definition: apiCAEP.h:72
PWP_BOOL allowedDataPrecisionSingle
Set to PWP_TRUE if single precision data supported in export.
Definition: apiCAEP.h:147
const char * fileDest
requested file destination.
Definition: apiCAEP.h:189
PWP_PROTOTYPE_DECL const char * PwCaeEnumBCs(CAEP_EXPORTER handle, PWP_UINT32 ndx, CAEP_BCINFO *pBCInfo)
Enumerate CAEP_BCINFO data for a CAE exporter instance.
Definition: apiCAEP.cxx:184
PWP_BOOL allowedDimension3D
Set to PWP_TRUE if 3D exports supported.
Definition: apiCAEP.h:159
const char * name
format Name.
Definition: apiCAEP.h:109
PWP_PROTOTYPE_DECL PWP_VOID PwDestroyCae(CAEP_EXPORTER *handle)
Destroy CAE exporter instance.
Definition: apiCAEP.cxx:116
PWP_BOOL allowedFileFormatUnformatted
Set to PWP_TRUE if Unformatted files supported in export.
Definition: apiCAEP.h:143
PWP_PROTOTYPE_DECL PWP_BOOL PwCaeElementType(CAEP_EXPORTER handle, PWGM_ENUM_ELEMTYPE which)
Test if CAE exporter instance supports the given element type.
Definition: apiCAEP.cxx:159
PWGM_ENUM_ELEMTYPE
Element type ids.
Definition: apiGridModel.h:673
PWP_PROTOTYPE_DECL PWP_UINT32 PwCaeGetVCCount(CAEP_EXPORTER handle)
Get the number of VC's for a CAE exporter instance.
Definition: apiCAEP.cxx:248
Volume condition definition information.
Definition: apiCAEP.h:168
const char * phystype
VC physical type name.
Definition: apiCAEP.h:171
PWP_ENUM_DIMENSION
Supported dimensionality values.
Definition: apiPWP.h:679
PWP_PROTOTYPE_DECL PWP_BOOL PwCaeGridWrite(CAEP_EXPORTER handle, PWGM_HGRIDMODEL model, const CAEP_WRITEINFO *pWriteInfo)
Initiates writing a grid model.
Definition: apiCAEP.cxx:260
int PWP_BOOL
logical value
Definition: apiPWP.h:221
PWP_ENUM_ENCODING
File encoding values.
Definition: apiPWP.h:698
CAE export write control information.
Definition: apiCAEP.h:186
PWP_PROTOTYPE_DECL PWP_UINT32 PwGetCaeFormatCount()
Get the number of supported CAE exporters.
Definition: apiCAEP.cxx:140
Boundary condition definition information.
Definition: apiCAEP.h:69
PWP_PROTOTYPE_DECL const char * PwEnumCaeFormat(PWP_UINT32 ndx, CAEP_FORMATINFO *pFormatInfo)
Enumerate CAEP_FORMATINFO data for all supported CAE exporters.
Definition: apiCAEP.cxx:129
PWP_UINT32 id
format guid.
Definition: apiCAEP.h:113
PWP_ENUM_DIMENSION dimension
export dimensionality.
Definition: apiCAEP.h:205
PWP_ENDIANNESS byteOrder
export byte order.
Definition: apiCAEP.h:209
PWP_ENUM_FILEDEST
File destination types.
Definition: apiPWP.h:659
PWP_ENDIANNESS
Flags used to indicate endianness or control endian behaviors in functions.
Definition: apiPWP.h:738
PWP_ENUM_PRECISION precision
export precision.
Definition: apiCAEP.h:201
PWP_ENUM_FILEDEST fileDest
Specifies the desired output destination type.
Definition: apiCAEP.h:123
PWP_BOOL allowedFileFormatASCII
Set to PWP_TRUE if ASCII files supported in export.
Definition: apiCAEP.h:135
An opaque handle to a grid model.
Definition: apiGridModel.h:327
CAEP exporter instance handle.
Definition: apiCAEP.h:221
PWP_PROTOTYPE_DECL CAEP_EXPORTER PwCreateCaeByName(const char name[])
Create CAE exporter instance with given name.
Definition: apiCAEP.cxx:105
int PWP_INT32
32-bit integer
Definition: apiPWP.h:191
PWP_BOOL allowedExportConditionsOnly
Set to PWP_TRUE if separate Condition export supported.
Definition: apiCAEP.h:127
Data and functions useful to PWP-API compliant plugins.