Pointwise Plugin SDK
|
Functions | |
PWP_BOOL | PwBlkCondition (PWGM_HBLOCK block, PWGM_CONDDATA *pCondData) |
Get the block condition data. More... | |
PWP_BOOL | PwBlkSetExportName (PWGM_HBLOCK block, const char *name) |
Set the name used to identify the block or group of blocks in the exported grid. More... | |
PWP_BOOL | PwBlock (PWGM_HBLOCK block, PWGM_BLOCKDATA *pBlockData) |
Get the block data. More... | |
PWP_UINT32 | PwModBlockCount (PWGM_HGRIDMODEL model) |
Get the number of block elements in the model. More... | |
PWGM_HBLOCK | PwModEnumBlocks (PWGM_HGRIDMODEL model, PWP_UINT32 ndx) |
Sequentially enumerate the model block elements. More... | |
PWP_BOOL | PwModGetAttributeValue (PWGM_HGRIDMODEL model, const char *name, PWP_ENUM_VALTYPE bufType, void *buf, PWP_UINT count) |
Get an attribute's value. More... | |
PWP_BOOL | PwModGetAttributeString (PWGM_HGRIDMODEL model, const char *name, const char **val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeUINT (PWGM_HGRIDMODEL model, const char *name, PWP_UINT *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeUINT32 (PWGM_HGRIDMODEL model, const char *name, PWP_UINT32 *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeINT (PWGM_HGRIDMODEL model, const char *name, PWP_INT *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeINT32 (PWGM_HGRIDMODEL model, const char *name, PWP_INT32 *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeREAL (PWGM_HGRIDMODEL model, const char *name, PWP_REAL *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeFLOAT (PWGM_HGRIDMODEL model, const char *name, PWP_FLOAT *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeBOOL (PWGM_HGRIDMODEL model, const char *name, PWP_BOOL *val) |
Get an attribute value as a specific type. More... | |
PWP_BOOL | PwModGetAttributeEnum (PWGM_HGRIDMODEL model, const char *name, const char **val) |
Get an attribute value as a specific type. More... | |
These functions are used to access both structured and unstructured grid models.
PWP_BOOL PwBlkCondition | ( | PWGM_HBLOCK | block, |
PWGM_CONDDATA * | pCondData | ||
) |
Get the block condition data.
block | A block handle. |
pCondData | Pointer to a PWGM_CONDDATA buffer. |
Definition at line 99 of file apiGridModel.cxx.
References PWGM_HBLOCK_ISVALID, and PWP_FALSE.
Referenced by CaeBlock::condition().
PWP_BOOL PwBlkSetExportName | ( | PWGM_HBLOCK | block, |
const char * | name | ||
) |
Set the name used to identify the block or group of blocks in the exported grid.
block | A block handle. |
name | The export name. The assigned name has leading and trailing whitespace trimmed away. If null or the trimmed name is empty, any existing name is erased. |
The name is solver specific and can be any value that is appropriate for the export format (e.g. "VC_Inlet" or "33").
If multiple PWGM_HBLOCK entities are merged (joined, agglomed) in the exported grid, then this would be the name of the exported group. It is valid for the same name to be set on multiple blocks. For example, if blocks are merged by VC, then every block in a given VC group should be set to the same name.
Each unique export name represents a single <MeshModelReference> section in the a meshlink file.
Definition at line 117 of file apiGridModel.cxx.
References PWGM_HBLOCK_ISVALID, and PWP_FALSE.
Referenced by CaeBlock::setExportName().
PWP_BOOL PwBlock | ( | PWGM_HBLOCK | block, |
PWGM_BLOCKDATA * | pBlockData | ||
) |
Get the block data.
block | A block handle. |
pBlockData | Pointer to a PWGM_BLOCKDATA buffer. |
Definition at line 108 of file apiGridModel.cxx.
References PWGM_HBLOCK_ISVALID, and PWP_FALSE.
Referenced by CaeBlock::data(), and CaeStrBlock::data().
PWP_UINT32 PwModBlockCount | ( | PWGM_HGRIDMODEL | model | ) |
Get the number of block elements in the model.
model | The grid model handle. |
Definition at line 83 of file apiGridModel.cxx.
Referenced by CaeGridModel::blockCount().
PWGM_HBLOCK PwModEnumBlocks | ( | PWGM_HGRIDMODEL | model, |
PWP_UINT32 | ndx | ||
) |
Sequentially enumerate the model block elements.
model | The grid model handle. |
ndx | The block index starting at 0. |
Definition at line 91 of file apiGridModel.cxx.
Referenced by CaeBlock::moveNext(), CaeBlock::movePrev(), and CaeBlock::moveTo().
PWP_BOOL PwModGetAttributeBOOL | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_BOOL * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 207 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_BOOL.
Referenced by caeuExportBndryConditionsOnly(), caeuExportStructuredAsUnstructured(), and CaeGridModel::getAttribute().
PWP_BOOL PwModGetAttributeEnum | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
const char ** | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 215 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_ENUM.
Referenced by CaeGridModel::getAttributeEnum().
PWP_BOOL PwModGetAttributeFLOAT | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_FLOAT * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 194 of file apiGridModel.cxx.
References PwModGetAttributeREAL().
Referenced by CaeGridModel::getAttribute().
PWP_BOOL PwModGetAttributeINT | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_INT * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 165 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_INT.
Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeINT32().
PWP_BOOL PwModGetAttributeINT32 | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_INT32 * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 173 of file apiGridModel.cxx.
References PwModGetAttributeINT().
PWP_BOOL PwModGetAttributeREAL | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_REAL * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 186 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_REAL.
Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeFLOAT().
PWP_BOOL PwModGetAttributeString | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
const char ** | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 136 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_STRING.
Referenced by caeuFileByteOrder(), caeuFileEncoding(), caeuFilePrecision(), and CaeGridModel::getAttribute().
PWP_BOOL PwModGetAttributeUINT | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_UINT * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 144 of file apiGridModel.cxx.
References PwModGetAttributeValue(), and PWP_VALTYPE_UINT.
Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeUINT32().
PWP_BOOL PwModGetAttributeUINT32 | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_UINT32 * | val | ||
) |
Get an attribute value as a specific type.
model | The grid model handle. |
name | The attribute name. |
val | Pointer to a numeric value. |
Definition at line 152 of file apiGridModel.cxx.
References PwModGetAttributeUINT().
PWP_BOOL PwModGetAttributeValue | ( | PWGM_HGRIDMODEL | model, |
const char * | name, | ||
PWP_ENUM_VALTYPE | bufType, | ||
void * | buf, | ||
PWP_UINT | count | ||
) |
Get an attribute's value.
model | The grid model handle. |
name | The attribute name. |
bufType | The type of storage pointed to by buf. See note below. |
buf | The value storage buffer. See note below. |
count | Number of bufType items pointed to by buf. Typically, this is set to 1. |
bufType buf is ------------------- ------------- PWP_VALTYPE_STRING const char** PWP_VALTYPE_INT PWP_INT* PWP_VALTYPE_UINT PWP_UINT* PWP_VALTYPE_REAL PWP_REAL* PWP_VALTYPE_ENUM const char** PWP_VALTYPE_BOOL PWP_BOOL*
Definition at line 126 of file apiGridModel.cxx.
References PWP_FALSE.
Referenced by PwModGetAttributeBOOL(), PwModGetAttributeEnum(), PwModGetAttributeINT(), PwModGetAttributeREAL(), PwModGetAttributeString(), and PwModGetAttributeUINT().