Pointwise Plugin SDK
|
Functions | |
PWP_BOOL | caeuAssignInfoValue (const char key[], const char value[], bool createIfNotExists=true) |
Creates a key/value pair that defines a CAE info attribute. More... | |
PWP_BOOL | caeuExportBndryConditionsOnly (PWGM_HGRIDMODEL model) |
Get the user-requested bc export option. More... | |
PWP_BOOL | caeuExportStructuredAsUnstructured (PWGM_HGRIDMODEL model) |
Get the user-requested structured grid handling. More... | |
PWP_ENDIANNESS | caeuFileByteOrder (PWGM_HGRIDMODEL model) |
Get the user-requested file byte order. More... | |
PWP_ENUM_ENCODING | caeuFileEncoding (PWGM_HGRIDMODEL model) |
Get the user-requested file encoding. More... | |
PWP_ENUM_PRECISION | caeuFilePrecision (PWGM_HGRIDMODEL model) |
Get the user-requested file precision. More... | |
PWP_BOOL | caeuPublishHighOrderValueDefinitions (const PWP_UINT32 maxPolynomialDegree) |
Enables support for the export of high order meshes and publishes all needed value definitions. More... | |
PWP_BOOL | caeuPublishMeshLinkValueDefinitions (const char *indexScheme) |
Enables support for the export of MeshLink data and publishes all needed value definitions. More... | |
PWP_BOOL | caeuPublishValueDefinition (const char key[], PWP_ENUM_VALTYPE type, const char value[], const char access[], const char desc[], const char range[]) |
Creates a collection of key/value pairs that represent a published CAE attribute definition. More... | |
Implements the CAE variable manager subsystem.
These are CAEP wrappers for the PwuValueXxxx() functions.
PWP_BOOL caeuAssignInfoValue | ( | const char | key[], |
const char | value[], | ||
bool | createIfNotExists = true |
||
) |
Creates a key/value pair that defines a CAE info attribute.
key | The value key (name). |
value | The value. |
createIfNotExists | If true, the name/value pair will be silently created if it does not already exist. |
Definition at line 262 of file apiCAEPUtils.cxx.
References CAEP_INFO_GROUP, and PwuAssignValueEnum().
Referenced by CaePlugin< MT >::assignInfoValue(), caeuPublishHighOrderValueDefinitions(), and caeuPublishMeshLinkValueDefinitions().
PWP_BOOL caeuExportBndryConditionsOnly | ( | PWGM_HGRIDMODEL | model | ) |
Get the user-requested bc export option.
model | The grid model handle. |
Definition at line 328 of file apiCAEPUtils.cxx.
References PwModGetAttributeBOOL(), and PWP_FALSE.
PWP_BOOL caeuExportStructuredAsUnstructured | ( | PWGM_HGRIDMODEL | model | ) |
Get the user-requested structured grid handling.
model | The grid model handle. |
Definition at line 378 of file apiCAEPUtils.cxx.
References PwModGetAttributeBOOL(), and PWP_FALSE.
PWP_ENDIANNESS caeuFileByteOrder | ( | PWGM_HGRIDMODEL | model | ) |
Get the user-requested file byte order.
model | The grid model handle. |
Definition at line 307 of file apiCAEPUtils.cxx.
References PwModGetAttributeString(), PWP_ENDIAN_BIG, PWP_ENDIAN_LITTLE, and PwuGetOsEndianness().
PWP_ENUM_ENCODING caeuFileEncoding | ( | PWGM_HGRIDMODEL | model | ) |
Get the user-requested file encoding.
model | The grid model handle. |
Definition at line 337 of file apiCAEPUtils.cxx.
References PwModGetAttributeString(), PWP_ENCODING_ASCII, PWP_ENCODING_BINARY, and PWP_ENCODING_UNFORMATTED.
PWP_ENUM_PRECISION caeuFilePrecision | ( | PWGM_HGRIDMODEL | model | ) |
Get the user-requested file precision.
model | The grid model handle. |
Definition at line 359 of file apiCAEPUtils.cxx.
References PwModGetAttributeString(), PWP_PRECISION_DOUBLE, and PWP_PRECISION_SINGLE.
PWP_BOOL caeuPublishHighOrderValueDefinitions | ( | const PWP_UINT32 | maxPolynomialDegree | ) |
Enables support for the export of high order meshes and publishes all needed value definitions.
maxPolynomialDegree | The maximum polynomial degree supported. Range 1 to 4 inclusive. |
Definition at line 271 of file apiCAEPUtils.cxx.
References caeuAssignInfoValue(), and PWP_CAST_BOOL.
PWP_BOOL caeuPublishMeshLinkValueDefinitions | ( | const char * | indexScheme | ) |
Enables support for the export of MeshLink data and publishes all needed value definitions.
indexScheme | The exported mesh's indexing scheme. One of: "ZeroBased", "OneBased", or "Custom". |
Definition at line 292 of file apiCAEPUtils.cxx.
References caeuAssignInfoValue(), and PWP_CAST_BOOL.
PWP_BOOL caeuPublishValueDefinition | ( | const char | key[], |
PWP_ENUM_VALTYPE | type, | ||
const char | value[], | ||
const char | access[], | ||
const char | desc[], | ||
const char | range[] | ||
) |
Creates a collection of key/value pairs that represent a published CAE attribute definition.
key | The value key (name). |
type | The value data type. |
value | The value as a type-appropriate string. |
access | The value access flags. |
desc | The value description. |
range | The value range as a type-appropriate string. |
Definition at line 252 of file apiCAEPUtils.cxx.
References CAEP_VALUE_GROUP, and PwuPublishValueDefinition().
Referenced by CaePlugin< MT >::publishBoolValueDef(), CaePlugin< MT >::publishEnumValueDef(), CaePlugin< MT >::publishIntValueDef(), CaePlugin< MT >::publishRealValueDef(), CaePlugin< MT >::publishStringValueDef(), CaePlugin< MT >::publishUIntValueDef(), and CaePlugin< MT >::publishValueDef().