Pointwise Plugin SDK
Functions
+ Collaboration diagram for Variable Manager Tools:

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 caeuCombineAnisotropic (PWGM_HGRIDMODEL model)
 Get the user-requested recombine setting. 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 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...
 

Detailed Description

Implements the CAE variable manager subsystem.

These are CAEP wrappers for the PwuValueXxxx() functions.

Function Documentation

◆ caeuAssignInfoValue()

PWP_BOOL caeuAssignInfoValue ( const char  key[],
const char  value[],
bool  createIfNotExists = true 
)

Creates a key/value pair that defines a CAE info attribute.

Parameters
keyThe value key (name).
valueThe value.
createIfNotExistsIf true, the name/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the CAEP_INFO_GROUP group.
See also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, CAEP_INFO_GROUP

Definition at line 259 of file apiCAEPUtils.cxx.

References CAEP_INFO_GROUP, and PwuAssignValueEnum().

Referenced by CaePlugin< MT >::assignInfoValue().

◆ caeuCombineAnisotropic()

PWP_BOOL caeuCombineAnisotropic ( PWGM_HGRIDMODEL  model)

Get the user-requested recombine setting.

Parameters
modelThe grid model handle.
Returns
PWP_TRUE if TRex tet cells are recombined for export.

◆ caeuExportBndryConditionsOnly()

PWP_BOOL caeuExportBndryConditionsOnly ( PWGM_HGRIDMODEL  model)

Get the user-requested bc export option.

Parameters
modelThe grid model handle.
Returns
PWP_TRUE if user has requested that only boundary conditions should be exported.

Definition at line 290 of file apiCAEPUtils.cxx.

References PwModGetAttributeBOOL(), and PWP_FALSE.

◆ caeuExportStructuredAsUnstructured()

PWP_BOOL caeuExportStructuredAsUnstructured ( PWGM_HGRIDMODEL  model)

Get the user-requested structured grid handling.

Parameters
modelThe grid model handle.
Returns
PWP_TRUE if a fully structured grid is to be exported as if it were unstructured.

Definition at line 340 of file apiCAEPUtils.cxx.

References PwModGetAttributeBOOL(), and PWP_FALSE.

◆ caeuFileByteOrder()

PWP_ENDIANNESS caeuFileByteOrder ( PWGM_HGRIDMODEL  model)

Get the user-requested file byte order.

Parameters
modelThe grid model handle.
Returns
The file endianess.

Definition at line 269 of file apiCAEPUtils.cxx.

References PwModGetAttributeString(), PWP_ENDIAN_BIG, PWP_ENDIAN_LITTLE, and PwuGetOsEndianness().

◆ caeuFileEncoding()

PWP_ENUM_ENCODING caeuFileEncoding ( PWGM_HGRIDMODEL  model)

Get the user-requested file encoding.

Parameters
modelThe grid model handle.
Returns
The file encoding

Definition at line 299 of file apiCAEPUtils.cxx.

References PwModGetAttributeString(), PWP_ENCODING_ASCII, PWP_ENCODING_BINARY, and PWP_ENCODING_UNFORMATTED.

◆ caeuFilePrecision()

PWP_ENUM_PRECISION caeuFilePrecision ( PWGM_HGRIDMODEL  model)

Get the user-requested file precision.

Parameters
modelThe grid model handle.
Returns
The file precision

Definition at line 321 of file apiCAEPUtils.cxx.

References PwModGetAttributeString(), PWP_PRECISION_DOUBLE, and PWP_PRECISION_SINGLE.

◆ caeuPublishValueDefinition()

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.

Parameters
keyThe value key (name).
typeThe value data type.
valueThe value as a type-appropriate string.
accessThe value access flags.
descThe value description.
rangeThe value range as a type-appropriate string.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
The key/value pairs are created in the CAEP_VALUE_GROUP group.
These value definitions are discoverable in glyph using the pw::Application actions getCAESolverAttributeNames, get/setCAESolverAttributeDefinition, setCAESolverAttributeDefinition, and getCAESolverAttribute.
These values can be edited by the user in Pointwise using the "CAE/Set Solver Attributes..." menu.
See also
PwuPublishValueDefinition(), PwpGetValue(), PWP_ENUM_VALTYPE, CAEP_VALUE_GROUP

Definition at line 248 of file apiCAEPUtils.cxx.

References CAEP_VALUE_GROUP, PWP_FALSE, 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().