The data representing a CAE exporter instance. More...
#include <apiCAEPUtils.h>
Collaboration diagram for CAEP_RTITEM:
Public Attributes | |
| PWP_UINT32 | BCCnt |
| The number of BC definitions. More... | |
| PWP_BOOL | elemType [PWGM_ELEMTYPE_SIZE] |
| Array of supported element-type flags. More... | |
| PWP_UINT32 | ExtCnt |
| The number of valid file extensions. More... | |
| CAEP_FORMATINFO | FormatInfo |
| The CAE Plugin format data. More... | |
| FILE * | fp |
| Runtime FILE pointer. More... | |
| PWGM_HGRIDMODEL | model |
| Runtime grid model handle to export. More... | |
| PWU_RTITEM * | pApiData |
| Pointer to the associated PWU_RTITEM structure. More... | |
| CAEP_BCINFO * | pBCInfo |
| Pointer to an array of supported BC definitions. More... | |
| const char ** | pFileExt |
| Pointer to an array of valid file extensions. More... | |
| CAEP_VCINFO * | pVCInfo |
| Pointer to an array of supported VC definitions. More... | |
| const CAEP_WRITEINFO * | pWriteInfo |
| Runtime export CAEP_WRITEINFO data. More... | |
| PWU_UNFDATA | unfData |
| Unformatted file I/O data. More... | |
| PWP_UINT32 | VCCnt |
| The number of VC definitions. More... | |
Detailed Description
The data representing a CAE exporter instance.
Definition at line 124 of file apiCAEPUtils.h.
Member Data Documentation
◆ BCCnt
| PWP_UINT32 CAEP_RTITEM::BCCnt |
The number of BC definitions.
If BCs are not supported, set this to 0.
Definition at line 146 of file apiCAEPUtils.h.
Referenced by CaePlugin< MT >::assignInfoValue(), CaePlugin< MT >::publishBoolValueDef(), CaePlugin< MT >::publishEnumValueDef(), CaePlugin< MT >::publishIntValueDef(), CaePlugin< MT >::publishRealValueDef(), CaePlugin< MT >::publishStringValueDef(), CaePlugin< MT >::publishUIntValueDef(), CaePlugin< MT >::publishValueDef(), PwCaeEnumBCs(), and PwCaeGetBCCount().
◆ elemType
| PWP_BOOL CAEP_RTITEM::elemType[PWGM_ELEMTYPE_SIZE] |
Array of supported element-type flags.
The exporter supports element type T if elemType[T] is PWP_TRUE. Where T is one of the PWGM_ENUM_ELEMTYPE values.
Definition at line 180 of file apiCAEPUtils.h.
Referenced by PwCaeElementType().
◆ ExtCnt
| PWP_UINT32 CAEP_RTITEM::ExtCnt |
The number of valid file extensions.
If not supported, set this to 0.
Definition at line 173 of file apiCAEPUtils.h.
Referenced by PwCaeEnumFileExt(), and PwCaeGetFileExtCount().
◆ FormatInfo
| CAEP_FORMATINFO CAEP_RTITEM::FormatInfo |
The CAE Plugin format data.
Accessed by the low-level API call PwEnumCaeFormat().
Definition at line 129 of file apiCAEPUtils.h.
Referenced by caeuFileClose(), caeuFileOpen(), CaePlugin< MT >::formatInfo(), PwCaeEnumVCs(), PwCaeFormat(), PwCaeGetVCCount(), and PwEnumCaeFormat().
◆ fp
| FILE* CAEP_RTITEM::fp |
Runtime FILE pointer.
This data member may be used by the plugin.
When a plugin defines FormatInfo.fileDest as PWP_FILEDEST_FILENAME, fp is automatically initialized by the SDK before runtimeWrite() is called and closed by the SDK after runtimeWrite() returns.
For all other FormatInfo.fileDest settings, fp will be null. The CAE exporter is allowed to initialize fp using the pwpFileOpen() function as needed.
- See also
- pwpFileOpen(), pwpFileClose(), pwpFileEof(), pwpFileFlush(), pwpFileGetpos(), pwpFileSetpos(), pwpFileRead(), pwpFileWrite(), pwpFileWriteStr(), pwpFileRewind(), pwpFileDelete(), pwpCwdPush(), pwpCwdPop()
Definition at line 199 of file apiCAEPUtils.h.
Referenced by caeuFileClose(), openFileName(), and CaePlugin< MT >::wrapRuntimeFile().
◆ model
| PWGM_HGRIDMODEL CAEP_RTITEM::model |
Runtime grid model handle to export.
This is the same handle as passed to runtimeWrite().
Definition at line 216 of file apiCAEPUtils.h.
Referenced by PwCaeGridWrite().
◆ pApiData
| PWU_RTITEM* CAEP_RTITEM::pApiData |
Pointer to the associated PWU_RTITEM structure.
Definition at line 133 of file apiCAEPUtils.h.
Referenced by CaePlugin< MT >::apiInfo(), caeuProgressBeginStep(), caeuProgressEnd(), caeuProgressIncr(), caeuProgressInit(), caeuSendDebugMsg(), caeuSendErrorMsg(), caeuSendInfoMsg(), caeuSendWarningMsg(), and CaePlugin< MT >::isLicensed().
◆ pBCInfo
| CAEP_BCINFO* CAEP_RTITEM::pBCInfo |
Pointer to an array of supported BC definitions.
Accessed by the CAEP-API call PwCaeEnumBCs(). If BCs are not supported, set this to null.
Definition at line 140 of file apiCAEPUtils.h.
Referenced by PwCaeEnumBCs().
◆ pFileExt
| const char** CAEP_RTITEM::pFileExt |
Pointer to an array of valid file extensions.
Accessed by the CAEP-API call PwCaeEnumFileExt(). If not supported, set this to null.
Definition at line 167 of file apiCAEPUtils.h.
Referenced by PwCaeEnumFileExt().
◆ pVCInfo
| CAEP_VCINFO* CAEP_RTITEM::pVCInfo |
Pointer to an array of supported VC definitions.
Accessed by the CAEP-API call PwCaeEnumVCs(). If VCs are not supported, set this to null.
Definition at line 153 of file apiCAEPUtils.h.
Referenced by PwCaeEnumVCs().
◆ pWriteInfo
| const CAEP_WRITEINFO* CAEP_RTITEM::pWriteInfo |
Runtime export CAEP_WRITEINFO data.
This is the same pointer passed to runtimeWrite().
Definition at line 222 of file apiCAEPUtils.h.
Referenced by PwCaeGridWrite().
◆ unfData
| PWU_UNFDATA CAEP_RTITEM::unfData |
Unformatted file I/O data.
Used by the PwuUnfXxxx() helper functions. This data member is for internal use only.
- See also
- PwuUnfFileSetEndianness(), PwuUnfFileGetEndianness(), PwuUnfFileBegin(), PwuUnfRecBegin(), PwuUnfRecWriteArr(), PwuUnfRecWriteBuf(), PwuUnfRecWriteEndianBuf()
Definition at line 210 of file apiCAEPUtils.h.
◆ VCCnt
| PWP_UINT32 CAEP_RTITEM::VCCnt |
The number of VC definitions.
Accessed by the low-level API call PwCaeGetFileExtCount(). If VCs are not supported, set this to 0.
Definition at line 160 of file apiCAEPUtils.h.
Referenced by PwCaeEnumVCs(), and PwCaeGetVCCount().
The documentation for this struct was generated from the following file: