Pointwise Plugin SDK
Functions
Common Grid Export Functions
The Fidelity Pointwise Grid Model API » Using C » Export Functions
+ Collaboration diagram for Common Grid Export Functions:

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 PwModNdxBlkCondition (const PWGM_HGRIDMODEL model, const PWP_UINT32 ndx, PWGM_CONDDATA *pCondData)
 Sequentially enumerate the model block condition data. 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...
 

Detailed Description

These functions are used to access both structured and unstructured grid models.

Function Documentation

◆ PwBlkCondition()

PWP_BOOL PwBlkCondition ( PWGM_HBLOCK  block,
PWGM_CONDDATA *  pCondData 
)

Get the block condition data.

Parameters
blockA block handle.
pCondDataPointer to a PWGM_CONDDATA buffer.
Returns
PWP_TRUE on success

Definition at line 99 of file apiGridModel.cxx.

References PWGM_HBLOCK_ISVALID, and PWP_FALSE.

Referenced by CaeBlock::condition(), and PwModNdxBlkCondition().

◆ PwBlkSetExportName()

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.

Parameters
blockA block handle.
nameThe 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.
Returns
PWP_TRUE on success.
Note
Setting the name is only required for plugins that have the "MeshLinkSupported" info value set true.

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.

See also
MeshLinkSupported, IndexScheme

Definition at line 117 of file apiGridModel.cxx.

References PWGM_HBLOCK_ISVALID, and PWP_FALSE.

Referenced by CaeBlock::setExportName().

◆ PwBlock()

PWP_BOOL PwBlock ( PWGM_HBLOCK  block,
PWGM_BLOCKDATA *  pBlockData 
)

Get the block data.

Parameters
blockA block handle.
pBlockDataPointer to a PWGM_BLOCKDATA buffer.
Returns
PWP_TRUE on success.

Definition at line 108 of file apiGridModel.cxx.

References PWGM_HBLOCK_ISVALID, and PWP_FALSE.

Referenced by CaeBlock::data(), and CaeStrBlock::data().

◆ PwModBlockCount()

PWP_UINT32 PwModBlockCount ( PWGM_HGRIDMODEL  model)

Get the number of block elements in the model.

Parameters
modelThe grid model handle.

Definition at line 83 of file apiGridModel.cxx.

Referenced by CaeGridModel::blockCount().

◆ PwModEnumBlocks()

PWGM_HBLOCK PwModEnumBlocks ( PWGM_HGRIDMODEL  model,
PWP_UINT32  ndx 
)

Sequentially enumerate the model block elements.

Parameters
modelThe grid model handle.
ndxThe block index < PwModBlockCount().
See also
PwModBlockCount()
Sample usage:
PWP_UINT32 eTotCnt;
PWGM_ELEMCOUNTS eCounts;
PWP_UINT32 ndx = 0;
PWGM_HBLOCK hBlk = PwModEnumBlocks(model, ndx);
while (PWGM_HBLOCK_ISVALID(hBlk)) {
eTotCnt = PwBlkElementCount(hBlk, &eCounts);
// ...etc...
hBlk = PwModEnumBlocks(model, ++ndx);
}

Definition at line 91 of file apiGridModel.cxx.

Referenced by CaeBlock::moveNext(), CaeBlock::movePrev(), CaeBlock::moveTo(), PwModNdxBlkCondition(), and PwModNdxBlkElementCount().

◆ PwModGetAttributeBOOL()

PWP_BOOL PwModGetAttributeBOOL ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_BOOL *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 207 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_BOOL.

Referenced by caeuExportBndryConditionsOnly(), caeuExportStructuredAsUnstructured(), and CaeGridModel::getAttribute().

◆ PwModGetAttributeEnum()

PWP_BOOL PwModGetAttributeEnum ( PWGM_HGRIDMODEL  model,
const char *  name,
const char **  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 215 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_ENUM.

Referenced by CaeGridModel::getAttributeEnum().

◆ PwModGetAttributeFLOAT()

PWP_BOOL PwModGetAttributeFLOAT ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_FLOAT *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 194 of file apiGridModel.cxx.

References PwModGetAttributeREAL().

Referenced by CaeGridModel::getAttribute().

◆ PwModGetAttributeINT()

PWP_BOOL PwModGetAttributeINT ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_INT *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 165 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_INT.

Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeINT32().

◆ PwModGetAttributeINT32()

PWP_BOOL PwModGetAttributeINT32 ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_INT32 *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 173 of file apiGridModel.cxx.

References PwModGetAttributeINT().

◆ PwModGetAttributeREAL()

PWP_BOOL PwModGetAttributeREAL ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_REAL *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 186 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_REAL.

Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeFLOAT().

◆ PwModGetAttributeString()

PWP_BOOL PwModGetAttributeString ( PWGM_HGRIDMODEL  model,
const char *  name,
const char **  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 136 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_STRING.

Referenced by caeuFileByteOrder(), caeuFileEncoding(), caeuFilePrecision(), and CaeGridModel::getAttribute().

◆ PwModGetAttributeUINT()

PWP_BOOL PwModGetAttributeUINT ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_UINT *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 144 of file apiGridModel.cxx.

References PwModGetAttributeValue(), and PWP_VALTYPE_UINT.

Referenced by CaeGridModel::getAttribute(), and PwModGetAttributeUINT32().

◆ PwModGetAttributeUINT32()

PWP_BOOL PwModGetAttributeUINT32 ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_UINT32 *  val 
)

Get an attribute value as a specific type.

Parameters
modelThe grid model handle.
nameThe attribute name.
valPointer to a numeric value.
Returns
PWP_TRUE if value assigned. PWP_FALSE if the attribute does not exist or if the attribute value could not be converted to a numeric value.
Note
These functions are type specific PwModGetAttributeValue() wrappers.
See also
PwModGetAttributeValue()
Sample usage:
const char *strAttr;
if (PwModGetAttributeString(model, "strAttr", &strAttr)) {
}
PWP_UINT32 u32Attr;
if (PwModGetAttributeUINT32(model, "u32Attr", &u32Attr)) {
}
PWP_INT32 i32Attr;
if (PwModGetAttributeINT32(model, "i32Attr", &i32Attr)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeUINT(model, "uAttr", &uAttr)) {
}
PWP_INT iAttr;
if (PwModGetAttributeINT(model, "iAttr", &iAttr)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeREAL(model, "rAttr", &rAttr)) {
}
PWP_FLOAT fAttr;
if (PwModGetAttributeFLOAT(model, "fAttr", &fAttr)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeBOOL(model, "bAttr", &bAttr)) {
}
const char *enumAttr;
if (PwModGetAttributeEnum(model, "enumAttr", &enumAttr)) {
}

Definition at line 152 of file apiGridModel.cxx.

References PwModGetAttributeUINT().

◆ PwModGetAttributeValue()

PWP_BOOL PwModGetAttributeValue ( PWGM_HGRIDMODEL  model,
const char *  name,
PWP_ENUM_VALTYPE  bufType,
void *  buf,
PWP_UINT  count 
)

Get an attribute's value.

Parameters
modelThe grid model handle.
nameThe attribute name.
bufTypeThe type of storage pointed to by buf. See note below.
bufThe value storage buffer. See note below.
countNumber of bufType items pointed to by buf. Typically, this is set to 1.
Returns
PWP_TRUE if value assigned. PWP_FALSE if attribute does not exist.
Note
Given bufType, buf must be a pointer of type: 
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*
See also
PwModGetAttributeString(), PwModGetAttributeUINT(), PwModGetAttributeUINT32(), PwModGetAttributeINT(), PwModGetAttributeINT32(), PwModGetAttributeREAL(), PwModGetAttributeFLOAT(), PwModGetAttributeBOOL(), PwModGetAttributeEnum()
Sample usage:
const char *strAttr = 0;
if (PwModGetAttributeValue(model, "strAttr", PWP_VALTYPE_STRING, &strAttr, 1)) {
}
PWP_UINT uAttr;
if (PwModGetAttributeValue(model, "uAttr", PWP_VALTYPE_UINT, &uAttr, 1)) {
}
PWP_INT iAttr;
if (PwModGetAttributeValue(model, "iAttr", PWP_VALTYPE_INT, &iAttr, 1)) {
}
PWP_REAL rAttr;
if (PwModGetAttributeValue(model, "rAttr", PWP_VALTYPE_REAL, &rAttr, 1)) {
}
PWP_BOOL bAttr;
if (PwModGetAttributeValue(model, "bAttr", PWP_VALTYPE_BOOL, &bAttr, 1)) {
}
const char *enumAttr = 0;
if (PwModGetAttributeValue(model, "enumAttr", PWP_VALTYPE_ENUM, &enumAttr, 1)) {
}
PWP_UINT uArray[5];
PWP_UINT count = sizeof(uArray) / sizeof(uArray[0]);
if (PwModGetAttributeValue(model, "uArray", PWP_VALTYPE_UINT, uArray, count)) {
// Attribute arrays are not supported at this time.
// Only uArray[0] will be set.
}

Definition at line 126 of file apiGridModel.cxx.

References PWP_FALSE.

Referenced by PwModGetAttributeBOOL(), PwModGetAttributeEnum(), PwModGetAttributeINT(), PwModGetAttributeREAL(), PwModGetAttributeString(), and PwModGetAttributeUINT().

◆ PwModNdxBlkCondition()

PWP_BOOL PwModNdxBlkCondition ( const PWGM_HGRIDMODEL  model,
const PWP_UINT32  ndx,
PWGM_CONDDATA *  pCondData 
)
inline

Sequentially enumerate the model block condition data.

Parameters
modelThe grid model handle.
ndxThe block index < PwModBlockCount().
pCondDataPointer to a PWGM_CONDDATA buffer.
See also
PwBlkCondition(), PwModEnumBlocks()
Sample usage:
PWP_UINT32 ndx = 0;
PWGM_CONDDATA cData;
while (PwModNdxBlkCondition(model, ndx++, &cData)) {
// ...etc...
}
Equivalent to:
PwBlkCondition(PwModEnumBlocks(model, ndx), pCondData);

Definition at line 1338 of file apiGridModel.h.

References PwBlkCondition(), and PwModEnumBlocks().

PWP_VALTYPE_STRING
@ PWP_VALTYPE_STRING
transfer value is a const char*
Definition: apiPWP.h:697
PWP_UINT32
unsigned int PWP_UINT32
32-bit unsigned integer
Definition: apiPWP.h:210
PWP_INT32
int PWP_INT32
32-bit integer
Definition: apiPWP.h:207
PWP_UINT
PWP_UINT32 PWP_UINT
unsigned integer same size as void*
Definition: apiPWP.h:285
PwModNdxBlkCondition
PWP_BOOL PwModNdxBlkCondition(const PWGM_HGRIDMODEL model, const PWP_UINT32 ndx, PWGM_CONDDATA *pCondData)
Sequentially enumerate the model block condition data.
Definition: apiGridModel.h:1338
PwModGetAttributeUINT32
PWP_BOOL PwModGetAttributeUINT32(PWGM_HGRIDMODEL model, const char *name, PWP_UINT32 *val)
Definition: apiGridModel.cxx:152
PwModGetAttributeFLOAT
PWP_BOOL PwModGetAttributeFLOAT(PWGM_HGRIDMODEL model, const char *name, PWP_FLOAT *val)
Definition: apiGridModel.cxx:194
PWGM_HBLOCK_ISVALID
#define PWGM_HBLOCK_ISVALID(h)
Returns non-zero value if handle is valid.
Definition: apiGridModel.h:348
PwBlkElementCount
PWP_UINT32 PwBlkElementCount(PWGM_HBLOCK block, PWGM_ELEMCOUNTS *pCounts)
Get the number of block elements.
Definition: apiGridModel.cxx:309
PWP_VALTYPE_REAL
@ PWP_VALTYPE_REAL
transfer value is a PWP_REAL
Definition: apiPWP.h:700
PwBlkCondition
PWP_BOOL PwBlkCondition(PWGM_HBLOCK block, PWGM_CONDDATA *pCondData)
Get the block condition data.
Definition: apiGridModel.cxx:99
PWP_REAL
double PWP_REAL
64-bit real
Definition: apiPWP.h:264
PWGM_HBLOCK
An opaque handle to a grid block element.
Definition: apiGridModel.h:345
PwModGetAttributeREAL
PWP_BOOL PwModGetAttributeREAL(PWGM_HGRIDMODEL model, const char *name, PWP_REAL *val)
Definition: apiGridModel.cxx:186
PWGM_ELEMCOUNTS
Element count information.
Definition: apiGridModel.h:774
PwModGetAttributeValue
PWP_BOOL PwModGetAttributeValue(PWGM_HGRIDMODEL model, const char *name, PWP_ENUM_VALTYPE bufType, void *buf, PWP_UINT count)
Get an attribute's value.
Definition: apiGridModel.cxx:126
PwModGetAttributeBOOL
PWP_BOOL PwModGetAttributeBOOL(PWGM_HGRIDMODEL model, const char *name, PWP_BOOL *val)
Definition: apiGridModel.cxx:207
PWP_FLOAT
float PWP_FLOAT
32-bit real
Definition: apiPWP.h:261
PwModGetAttributeINT
PWP_BOOL PwModGetAttributeINT(PWGM_HGRIDMODEL model, const char *name, PWP_INT *val)
Definition: apiGridModel.cxx:165
PWP_INT
PWP_INT32 PWP_INT
integer same size as void*
Definition: apiPWP.h:282
PWP_VALTYPE_BOOL
@ PWP_VALTYPE_BOOL
transfer value is a PWP_BOOL
Definition: apiPWP.h:702
PWP_BOOL
int PWP_BOOL
logical value
Definition: apiPWP.h:303
PWP_VALTYPE_INT
@ PWP_VALTYPE_INT
transfer value is a PWP_INT
Definition: apiPWP.h:698
PwModGetAttributeINT32
PWP_BOOL PwModGetAttributeINT32(PWGM_HGRIDMODEL model, const char *name, PWP_INT32 *val)
Definition: apiGridModel.cxx:173
PWGM_CONDDATA
Condition descriptor data type.
Definition: apiGridModel.h:644
PwModEnumBlocks
PWGM_HBLOCK PwModEnumBlocks(PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
Sequentially enumerate the model block elements.
Definition: apiGridModel.cxx:91
PwModGetAttributeString
PWP_BOOL PwModGetAttributeString(PWGM_HGRIDMODEL model, const char *name, const char **val)
Get an attribute value as a specific type.
Definition: apiGridModel.cxx:136
PWP_VALTYPE_ENUM
@ PWP_VALTYPE_ENUM
transfer value is a const char*
Definition: apiPWP.h:701
PWP_VALTYPE_UINT
@ PWP_VALTYPE_UINT
transfer value is a PWP_UINT
Definition: apiPWP.h:699
PwModGetAttributeUINT
PWP_BOOL PwModGetAttributeUINT(PWGM_HGRIDMODEL model, const char *name, PWP_UINT *val)
Definition: apiGridModel.cxx:144
PwModGetAttributeEnum
PWP_BOOL PwModGetAttributeEnum(PWGM_HGRIDMODEL model, const char *name, const char **val)
Definition: apiGridModel.cxx:215