Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apiGRDP.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Pointwise Grid Import Plugin API (GRDP-API) v1.0
4  *
5  * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
6  *
7  ***************************************************************************/
8 
9 #ifndef _APIGRDP_H_
10 #define _APIGRDP_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 GRDP_VALUE_GROUP "SDK.Plugin.GRDP"
50 #define GRDP_GROUP_VALUE_NAMES PWU_GROUP_VALUE_NAMES(GRDP_VALUE_GROUP)
51 #define GRDP_GROUP_VALUE_DEFNS PWU_GROUP_VALUE_DEFNS(GRDP_VALUE_GROUP)
52 
53 #define GRDP_INFO_GROUP GRDP_VALUE_GROUP ".INFO"
54 
55 
56 /***********************************************************/
57 /***********************************************************/
62 /*---------------------------------------------------------*/
75  const char *group;
76 
79  const char *name;
80 
84 
94 
97  const char *exts;
98 };
99 
100 
101 /*---------------------------------------------------------*/
111  const char *fileDest;
112 
116 
119  //PWP_ENUM_ENCODING encoding;
120 
123  //PWP_ENUM_PRECISION precision;
124 
127  //PWP_ENUM_DIMENSION dimension;
128 
131  //PWP_ENDIANNESS byteOrder;
132 };
133 
134 
135 /*---------------------------------------------------------*/
145  /* DOXGRP_APIGRDP_TYPES */
147 
148 
149 /***********************************************************/
150 /***********************************************************/
155 /*---------------------------------------------------------*/
168 PWP_PROTOTYPE_DECL GRDP_IMPORTER
170 
171 
172 /*---------------------------------------------------------*/
183 PWP_PROTOTYPE_DECL GRDP_IMPORTER
184 PwCreateGrdpByName(const char name[]);
185 
186 
187 /*---------------------------------------------------------*/
196 PWP_PROTOTYPE_DECL PWP_VOID
198 
199 
200 /*---------------------------------------------------------*/
221 PWP_PROTOTYPE_DECL const char*
222 PwEnumGrdpFormat(PWP_UINT32 ndx, GRDP_FORMATINFO *pFormatInfo);
223 
224 
225 /*---------------------------------------------------------*/
230 PWP_PROTOTYPE_DECL PWP_UINT32
232 
233 
234 /*---------------------------------------------------------*/
257 PWP_PROTOTYPE_DECL const char*
258 PwGrdpFormat(GRDP_IMPORTER handle, GRDP_FORMATINFO *pFormatInfo);
259 
260 
261 /*---------------------------------------------------------*/
282 PWP_PROTOTYPE_DECL PWP_BOOL
284  const GRDP_READINFO *pReadInfo);
285 
290 } /* extern "C" */
291 
292 #endif /* !_APIGRDP_H_ */
const char * PwGrdpFormat(GRDP_IMPORTER handle, GRDP_FORMATINFO *pFormatInfo)
Get GRDP_FORMATINFO data for a GRDP importer handle.
Definition: apiGRDP.cxx:133
PWP_BOOL PwGridRead(GRDP_IMPORTER handle, PWGM_HGRIDMODEL model, const GRDP_READINFO *pReadInfo)
Initiates reading a grid model.
Definition: apiGRDP.cxx:175
GRDP importer instance handle.
Definition: apiGRDP.h:144
unsigned int PWP_UINT32
32-bit unsigned integer
Definition: apiPWP.h:210
Pointwise Plugin API (PWP-API)
GRDP_IMPORTER PwCreateGrdpByName(const char name[])
Create GRDP importer instance with given name.
Definition: apiGRDP.cxx:91
void PWP_VOID
no value
Definition: apiPWP.h:317
PWP_UINT32 id
format guid.
Definition: apiGRDP.h:83
const char * exts
Space delimited list of file extensions.
Definition: apiGRDP.h:97
Pointwise Grid Model API Specification (PWGM-API)
#define PWP_DECLARE_HANDLE(name)
Declares a root-level, strongly-typed data handle type.
Definition: apiPWP.h:340
Grid import read control information.
Definition: apiGRDP.h:108
const char * name
format Name.
Definition: apiGRDP.h:79
PWP_VOID PwDestroyGrdp(GRDP_IMPORTER *handle)
Destroy GRDP importer instance.
Definition: apiGRDP.cxx:102
GRDP_IMPORTER PwCreateGrdpById(PWP_UINT32 id)
Create GRDP importer instance with given id.
Definition: apiGRDP.cxx:80
int PWP_BOOL
logical value
Definition: apiPWP.h:303
PWP_UINT32 PwGetGrdpFormatCount()
Get the number of supported GRDP importers.
Definition: apiGRDP.cxx:126
The information returned for each supported GRDP importer.
Definition: apiGRDP.h:70
PWP_ENUM_FILEDEST
File destination types.
Definition: apiPWP.h:743
const char * group
The plugin's group name.
Definition: apiGRDP.h:75
An opaque handle to a grid model.
Definition: apiGridModel.h:326
PWP_BOOL importConditions
If true, the importer should set BC and VC data when available.
Definition: apiGRDP.h:115
const char * PwEnumGrdpFormat(PWP_UINT32 ndx, GRDP_FORMATINFO *pFormatInfo)
Enumerate GRDP_FORMATINFO data for all supported GRDP importers.
Definition: apiGRDP.cxx:115
PWP_ENUM_FILEDEST fileDest
Specifies the desired output destination type.
Definition: apiGRDP.h:93
const char * fileDest
requested file destination.
Definition: apiGRDP.h:111
Data and functions useful to PWP-API compliant plugins.