Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Classes | Macros
PWGM-API Opaque Data Handle Types
+ Collaboration diagram for PWGM-API Opaque Data Handle Types:

Classes

struct  PWGM_HBLOCK
 An opaque handle to a grid block element. More...
 
struct  PWGM_HBLOCKASSEMBLER
 An opaque handle to an unstructured block assembler. More...
 
struct  PWGM_HBNDRY
 An opaque handle to a structured block boundary. More...
 
struct  PWGM_HCNXN
 An opaque handle to a structured, inter-block connection. More...
 
struct  PWGM_HCONNECTOR
 An opaque handle to a grid connector element. More...
 
struct  PWGM_HDOMAIN
 An opaque handle to a grid domain element. More...
 
struct  PWGM_HELEMENT
 Grid element handle declaration. More...
 
struct  PWGM_HELEMENT_BASE
 Only used as a generic base handle for PWGM_HELEMENT. More...
 
struct  PWGM_HGRIDMODEL
 An opaque handle to a grid model. More...
 
struct  PWGM_HVERTEX
 An opaque handle to a grid vertex element. More...
 
struct  PWGM_HVERTEXLIST
 Grid vertex list handle declaration. More...
 
struct  PWGM_HVERTEXLIST_BASE
 Only used as a generic base handle for PWGM_HVERTEXLIST. More...
 

Macros

#define PWGM_HBLOCK_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCK_ID(h)   PWP_HEGRP_ID(h)
 gets the block's guid from the handle More...
 
#define PWGM_HBLOCK_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HBLOCK_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCKASSEMBLER_H(h)   PWP_HEGRP_H(h)
 gets the assembler's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBLOCKASSEMBLER_ID(h)   PWP_HEGRP_ID(h)
 gets the assembler's guid from the handle More...
 
#define PWGM_HBLOCKASSEMBLER_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HBLOCKASSEMBLER_MODEL(h)   PWP_HEGRP_H(h)
 gets the assembler's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBNDRY_H(h)   PWP_HEGRP_H(h)
 gets the boundary's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HBNDRY_ID(h)   PWP_HEGRP_ID(h)
 gets the boundary's guid from the handle More...
 
#define PWGM_HBNDRY_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HBNDRY_MODEL(h)   PWP_HEGRP_H(h)
 gets the boundary's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCNXN_H(h)   PWP_HEGRP_H(h)
 gets the connection's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCNXN_ID(h)   PWP_HEGRP_ID(h)
 gets the connection's guid from the handle More...
 
#define PWGM_HCNXN_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HCNXN_MODEL(h)   PWP_HEGRP_H(h)
 gets the connection's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCONNECTOR_H(h)   PWP_HEGRP_H(h)
 gets the connector's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HCONNECTOR_ID(h)   PWP_HEGRP_ID(h)
 gets the connector's guid from the handle More...
 
#define PWGM_HCONNECTOR_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 Returns non-zero value if handle is valid. More...
 
#define PWGM_HCONNECTOR_MODEL(h)   PWP_HEGRP_H(h)
 gets the connector's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HDOMAIN_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HDOMAIN_ID(h)   PWP_HEGRP_ID(h)
 gets the domain's guid from the handle More...
 
#define PWGM_HDOMAIN_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HDOMAIN_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_H(h)   PWP_HEGI_H(h)
 gets the element's PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_ID(h)   PWP_HEGI_ID(h)
 gets the element's guid from the handle More...
 
#define PWGM_HELEMENT_ISVALID(h)   PWP_HEGI_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HELEMENT_MODEL(h)   PWP_HEGI_H(h)
 gets the element's PWGM_HGRIDMODEL handle More...
 
#define PWGM_HELEMENT_PID(h)   PWP_HEGI_PID(h)
 gets the element's parent id More...
 
#define PWGM_HELEMENT_PTYPE(h)   PWP_HEGI_PTYPE(h)
 gets the element's parent handle type More...
 
#define PWGM_HGRIDMODEL_ISVALID(h)   PWP_HANDLE_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEX_H(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEX_ID(h)   PWP_HEGRP_ID(h)
 gets the vertex's guid from the handle More...
 
#define PWGM_HVERTEX_ISVALID(h)   PWP_HEGRP_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEX_MODEL(h)   PWP_HEGRP_H(h)
 gets the element's parent PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_H(h)   PWP_HEGI_H(h)
 gets the embedded PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_ID(h)   PWP_HEGI_ID(h)
 gets the embedded guid from the handle More...
 
#define PWGM_HVERTEXLIST_ISVALID(h)   PWP_HEGI_ISVALID(h)
 returns non-zero value if handle is valid More...
 
#define PWGM_HVERTEXLIST_MODEL(h)   PWP_HEGI_H(h)
 gets the embedded PWGM_HGRIDMODEL handle More...
 
#define PWGM_HVERTEXLIST_PID(h)   PWP_HEGI_PID(h)
 gets the embedded parent id More...
 
#define PWGM_HVERTEXLIST_PTYPE(h)   PWP_HEGI_PTYPE(h)
 gets the embedded parent handle type More...
 

Detailed Description

Opaque handles used to access export model data.

\par "Cell-centric Unstructured Grid Hierarchy:"
    PWGM_HGRIDMODEL
    |
    |---PWGM_HBLOCK[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   `---PWGM_HELEMENT[] 3D{tet, hex, wedge, pyramid} or 2D{tri, quad}
    |
    |---PWGM_HDOMAIN[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   `---PWGM_HELEMENT[] 3D{tri, quad} or 2D{bar}
    |
    `---PWGM_HVERTEX[]
\par "Face-centric Unstructured Grid Hierarchy:"
    PWGM_HGRIDMODEL
    |
    |---PWGM_HELEMENT[] 3D{tet, hex, wedge, pyramid} or 2D{tri, quad}
    |
    |---PWGM_FACESTREAM_DATA[] 3D{tri, quad} or 2D{bar}
    |
    `---PWGM_HVERTEX[]
\par "Structured Grid Hierarchy:"
    PWGM_HGRIDMODEL
    |
    |---PWGM_HBLOCK[]
    |   |
    |   |---PWGM_CONDDATA
    |   |
    |   |---PWGM_VERTDATA[]
    |   |
    |   |---PWGM_HCNXN[]
    |   |   |
    |   |   `---PWGM_CNXNDATA
    |   |
    |   `---PWGM_HBNDRY[]
    |       |
    |       |---PWGM_CONDDATA
    |       |
    |       `---PWGM_BNDRYDATA
    |
    |---PWGM_HCNXN[]
    |   |
    |   `---PWGM_CNXNDATA
    |
    `---PWGM_HBNDRY[]
        |
        |---PWGM_CONDDATA
        |
        `---PWGM_BNDRYDATA

Macro Definition Documentation

#define PWGM_HBLOCK_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 364 of file apiGridModel.h.

Referenced by CaeBlock::moveNext(), and CaeBlock::movePrev().

#define PWGM_HBLOCK_ID (   h)    PWP_HEGRP_ID(h)

gets the block's guid from the handle

Definition at line 366 of file apiGridModel.h.

Referenced by CaeBlock::index(), CaeBlock::moveNext(), CaeBlock::movePrev(), operator<(), and operator==().

#define PWGM_HBLOCK_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 348 of file apiGridModel.h.

Referenced by CaeBlock::isValid(), PwBlkCondition(), PwBlkElementCount(), PwBlkEnumElements(), PwBlkSetExportName(), and PwBlock().

#define PWGM_HBLOCK_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 368 of file apiGridModel.h.

Referenced by CaeUnsBlock::model(), and CaeStrBlock::model().

#define PWGM_HBLOCKASSEMBLER_H (   h)    PWP_HEGRP_H(h)

gets the assembler's parent PWGM_HGRIDMODEL handle

Definition at line 582 of file apiGridModel.h.

#define PWGM_HBLOCKASSEMBLER_ID (   h)    PWP_HEGRP_ID(h)

gets the assembler's guid from the handle

Definition at line 584 of file apiGridModel.h.

#define PWGM_HBLOCKASSEMBLER_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 568 of file apiGridModel.h.

#define PWGM_HBLOCKASSEMBLER_MODEL (   h)    PWP_HEGRP_H(h)

gets the assembler's parent PWGM_HGRIDMODEL handle

Definition at line 586 of file apiGridModel.h.

#define PWGM_HBNDRY_H (   h)    PWP_HEGRP_H(h)

gets the boundary's parent PWGM_HGRIDMODEL handle

Definition at line 473 of file apiGridModel.h.

#define PWGM_HBNDRY_ID (   h)    PWP_HEGRP_ID(h)

gets the boundary's guid from the handle

Definition at line 475 of file apiGridModel.h.

Referenced by CaeStrBoundary::data(), CaeStrBoundary::modelIndex(), operator<(), and operator==().

#define PWGM_HBNDRY_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 459 of file apiGridModel.h.

Referenced by CaeStrBoundary::isValid().

#define PWGM_HBNDRY_MODEL (   h)    PWP_HEGRP_H(h)

gets the boundary's parent PWGM_HGRIDMODEL handle

Definition at line 477 of file apiGridModel.h.

Referenced by CaeStrBoundary::data(), and CaeStrBoundary::model().

#define PWGM_HCNXN_H (   h)    PWP_HEGRP_H(h)

gets the connection's parent PWGM_HGRIDMODEL handle

Definition at line 498 of file apiGridModel.h.

#define PWGM_HCNXN_ID (   h)    PWP_HEGRP_ID(h)

gets the connection's guid from the handle

Definition at line 500 of file apiGridModel.h.

Referenced by CaeStrConnection::modelIndex(), operator<(), and operator==().

#define PWGM_HCNXN_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 484 of file apiGridModel.h.

Referenced by CaeStrConnection::isValid().

#define PWGM_HCNXN_MODEL (   h)    PWP_HEGRP_H(h)

gets the connection's parent PWGM_HGRIDMODEL handle

Definition at line 502 of file apiGridModel.h.

Referenced by CaeStrConnection::model().

#define PWGM_HCONNECTOR_H (   h)    PWP_HEGRP_H(h)

gets the connector's parent PWGM_HGRIDMODEL handle

Definition at line 523 of file apiGridModel.h.

#define PWGM_HCONNECTOR_ID (   h)    PWP_HEGRP_ID(h)

gets the connector's guid from the handle

Definition at line 525 of file apiGridModel.h.

#define PWGM_HCONNECTOR_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

Returns non-zero value if handle is valid.

Definition at line 509 of file apiGridModel.h.

#define PWGM_HCONNECTOR_MODEL (   h)    PWP_HEGRP_H(h)

gets the connector's parent PWGM_HGRIDMODEL handle

Definition at line 527 of file apiGridModel.h.

#define PWGM_HDOMAIN_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 390 of file apiGridModel.h.

Referenced by CaeUnsPatch::model(), CaeUnsPatch::moveNext(), and CaeUnsPatch::movePrev().

#define PWGM_HDOMAIN_ID (   h)    PWP_HEGRP_ID(h)

gets the domain's guid from the handle

Definition at line 392 of file apiGridModel.h.

Referenced by CaeUnsPatch::index().

#define PWGM_HDOMAIN_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 374 of file apiGridModel.h.

Referenced by CaeUnsPatch::isValid(), PwDomCondition(), PwDomElementCount(), and PwDomEnumElements().

#define PWGM_HDOMAIN_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 394 of file apiGridModel.h.

#define PWGM_HELEMENT_H (   h)    PWP_HEGI_H(h)

gets the element's PWGM_HGRIDMODEL handle

Definition at line 444 of file apiGridModel.h.

#define PWGM_HELEMENT_ID (   h)    PWP_HEGI_ID(h)

gets the element's guid from the handle

Definition at line 450 of file apiGridModel.h.

Referenced by CaeUnsElement::index(), operator<(), and operator==().

#define PWGM_HELEMENT_ISVALID (   h)    PWP_HEGI_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 429 of file apiGridModel.h.

Referenced by CaeUnsElement::isValid(), CaePlugin< MT >::isValid(), PwElemDataMod(), and PwElemDataModEnum().

#define PWGM_HELEMENT_MODEL (   h)    PWP_HEGI_H(h)

gets the element's PWGM_HGRIDMODEL handle

Definition at line 452 of file apiGridModel.h.

Referenced by CaeUnsElement::model().

#define PWGM_HELEMENT_PID (   h)    PWP_HEGI_PID(h)

gets the element's parent id

Definition at line 446 of file apiGridModel.h.

Referenced by CaeUnsEnumElementData::blockId(), operator<(), and operator==().

#define PWGM_HELEMENT_PTYPE (   h)    PWP_HEGI_PTYPE(h)

gets the element's parent handle type

Definition at line 448 of file apiGridModel.h.

Referenced by operator<(), and operator==().

#define PWGM_HGRIDMODEL_ISVALID (   h)    PWP_HANDLE_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 328 of file apiGridModel.h.

Referenced by PwGridRead().

#define PWGM_HVERTEX_H (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 414 of file apiGridModel.h.

Referenced by CaeUnsVertex::model(), CaeUnsVertex::moveNext(), and CaeUnsVertex::movePrev().

#define PWGM_HVERTEX_ID (   h)    PWP_HEGRP_ID(h)

gets the vertex's guid from the handle

Definition at line 416 of file apiGridModel.h.

Referenced by CaeUnsVertex::index(), operator<(), and operator==().

#define PWGM_HVERTEX_ISVALID (   h)    PWP_HEGRP_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 400 of file apiGridModel.h.

Referenced by CaeUnsVertex::isValid(), PwVertDataMod(), PwVertIndexMod(), and PwVertXyzVal().

#define PWGM_HVERTEX_MODEL (   h)    PWP_HEGRP_H(h)

gets the element's parent PWGM_HGRIDMODEL handle

Definition at line 418 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_H (   h)    PWP_HEGI_H(h)

gets the embedded PWGM_HGRIDMODEL handle

Definition at line 553 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_ID (   h)    PWP_HEGI_ID(h)

gets the embedded guid from the handle

Definition at line 559 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_ISVALID (   h)    PWP_HEGI_ISVALID(h)

returns non-zero value if handle is valid

Definition at line 538 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_MODEL (   h)    PWP_HEGI_H(h)

gets the embedded PWGM_HGRIDMODEL handle

Definition at line 561 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_PID (   h)    PWP_HEGI_PID(h)

gets the embedded parent id

Definition at line 555 of file apiGridModel.h.

#define PWGM_HVERTEXLIST_PTYPE (   h)    PWP_HEGI_PTYPE(h)

gets the embedded parent handle type

Definition at line 557 of file apiGridModel.h.