Pointwise Plugin SDK
|
The structured boundary class. More...
#include <CaeStrBoundary.h>
Public Member Functions | |
CaeStrBoundary () | |
Default constructor. More... | |
CaeStrBoundary (const CaeStrBoundary &src) | |
Copy constructor. More... | |
CaeStrBoundary (const CaeStrBoundaryGroup &group, PWP_UINT32 ndx=0) | |
Group and boundary index constructor. More... | |
bool | data (PWGM_BNDRYDATA &bData, PWGM_CONDDATA &cData) const |
Get both the boundary information and condition data. More... | |
bool | data (PWGM_BNDRYDATA &data) const |
Get information about the boundary. More... | |
bool | data (PWGM_CONDDATA &data) const |
Gets the boundary's condition data. More... | |
PWP_UINT32 | index () const |
Get the boundary's index in the group. More... | |
bool | isValid () const |
Determines a boundary's validity. More... | |
CaeStrGridModel | model () const |
Gets the structured grid model of which this boundary is a member. More... | |
PWP_UINT32 | modelIndex () const |
Get the boundary's model index. More... | |
CaeStrBoundary & | moveFirst () |
Rebinds an instance to the first boundary in the current group. More... | |
CaeStrBoundary & | moveFirst (const CaeStrBoundaryGroup &group) |
Rebinds an instance to the first boundary in the group. More... | |
CaeStrBoundary & | moveNext () |
Rebinds an instance to the next boundary in the group. More... | |
CaeStrBoundary & | movePrev () |
Rebinds an instance to the previous boundary in the group. More... | |
CaeStrBoundary & | moveTo (const CaeStrBoundaryGroup &group, PWP_UINT32 ndx) |
Rebinds an instance to a specific group and boundary. More... | |
CaeStrBoundary & | moveTo (PWP_UINT32 ndx) |
Rebinds an instance to a specific boundary within the current group. More... | |
operator PWGM_HBNDRY () const | |
The PWGM_HBNDRY cast operator. More... | |
bool | operator!= (const CaeStrBoundary &rhs) const |
Compares two CaeStrBoundary instances for inequality. More... | |
CaeStrBoundary & | operator++ () |
Prefix increment to the next boundary in the group. More... | |
CaeStrBoundary | operator++ (int) |
Postfix increment to the next boundary in the group. More... | |
CaeStrBoundary & | operator-- () |
Prefix decrement to the previous boundary in the group. More... | |
CaeStrBoundary | operator-- (int) |
Postfix decrement to the previous boundary in the group. More... | |
bool | operator< (const CaeStrBoundary &rhs) const |
Compares the relative order of two CaeStrBoundary instances. More... | |
CaeStrBoundary & | operator= (const CaeStrBoundary &rhs) |
Assignment operator. More... | |
bool | operator== (const CaeStrBoundary &rhs) const |
Compares two CaeStrBoundary instances for equality. More... | |
bool | operator> (const PWGM_HBNDRY &rhs) |
Compares the relative order of two CaeStrBoundary instances. More... | |
~CaeStrBoundary () | |
Destructor. More... | |
Protected Attributes | |
const CaeStrBoundaryGroup * | group_ |
The owning boundary group. More... | |
PWP_UINT32 | groupNdx_ |
The current index in the group's index space. More... | |
PWGM_HBNDRY | h_ |
The bound PWGM_HBNDRY. More... | |
The structured boundary class.
The CaeStrBoundary class represents a single, ijk-structured grid model boundary. The boundaries are indexed starting from 0 to CaeStrBoundaryGroup::elementCount() - 1.
A CaeStrBoundary object is aware of its relative position in its boundary group. As a result, a given boundary object can be moved (iterated) to its previous or next neighbor boundary. It can also be moved to the first boundary or to a boundary at a given index. After being moved, a CaeStrBoundary object will return information about the grid boundary at its current position.
The following snippets are extracted from the structured XML sample plugin (CaeStrXMLCPP).
During the execution of the CaeStrXMLCPP::writeBlock()
method, the CaeStrXMLCPP plugin writes a block's boundaries with a call to the CaeStrXMLCPP::writeBlkBoundaries()
method. First, it writes an XML <boundaries>
tag. Then it moves through the boundaries one by one and calls the CaeStrXMLCPP::writeBoundaryAndConditionData()
method. Finally, a closing </boundaries>
tag is written.
CaeStrXMLCPP::writeBoundaryAndConditionData()
writes an XML <boundary>
tag. Next, the boundary's range and condition are exported with calls to CaeStrXMLCPP::writeRange() and CaeStrXMLCPP::writeConditionData(). Finally, a closing </boundary>
tag is written.
CaeStrXMLCPP::writeRange()
writes a self-closed XML <range
/> tag.
CaeStrXMLCPP::writeConditionData()
writes a self-closed XML <condition
/> tag.
Definition at line 62 of file CaeStrBoundary.h.
|
inline |
Default constructor.
Constructs an invalid boundary.
Definition at line 71 of file CaeStrBoundary.h.
References h_.
|
inline |
Group and boundary index constructor.
Constructs an structured boundary object bound to the boundary at the specified index.
group | The owning structured boundary group. |
ndx | The boundary's index within the group. |
Definition at line 83 of file CaeStrBoundary.h.
|
inline |
Copy constructor.
Binds this boundary to the same boundary as src.
src | An boundary instance. |
Definition at line 93 of file CaeStrBoundary.h.
|
inline |
Destructor.
Definition at line 100 of file CaeStrBoundary.h.
|
inline |
Get both the boundary information and condition data.
bData | The PWGM_BNDRYDATA buffer. |
cData | The PWGM_CONDDATA buffer. |
Definition at line 155 of file CaeStrBoundary.h.
References h_, PWGM_HBNDRY_ID, PWGM_HBNDRY_MODEL, and PwModNdxBoundaryAndCondition().
|
inline |
Get information about the boundary.
data | The PWGM_BNDRYDATA buffer. |
Definition at line 134 of file CaeStrBoundary.h.
References h_, and PwBoundary().
Referenced by data().
|
inline |
Gets the boundary's condition data.
data | The PWGM_CONDDATA buffer. |
Definition at line 143 of file CaeStrBoundary.h.
References data(), h_, and PwBndryCondition().
|
inline |
Get the boundary's index in the group.
Definition at line 114 of file CaeStrBoundary.h.
References groupNdx_.
|
inline |
Determines a boundary's validity.
Definition at line 162 of file CaeStrBoundary.h.
References h_, and PWGM_HBNDRY_ISVALID.
|
inline |
Gets the structured grid model of which this boundary is a member.
Definition at line 104 of file CaeStrBoundary.h.
References h_, and PWGM_HBNDRY_MODEL.
|
inline |
Get the boundary's model index.
Definition at line 125 of file CaeStrBoundary.h.
References h_, and PWGM_HBNDRY_ID.
|
inline |
Rebinds an instance to the first boundary in the current group.
Definition at line 226 of file CaeStrBoundary.h.
References CaeStrBoundaryGroup::enumBoundaries(), group_, groupNdx_, and h_.
|
inline |
Rebinds an instance to the first boundary in the group.
group | The boundary group. |
Definition at line 215 of file CaeStrBoundary.h.
|
inline |
Rebinds an instance to the next boundary in the group.
Definition at line 241 of file CaeStrBoundary.h.
|
inline |
Rebinds an instance to the previous boundary in the group.
Definition at line 277 of file CaeStrBoundary.h.
|
inline |
Rebinds an instance to a specific group and boundary.
group | The boundary group. |
ndx | The boundary's index in the group's index space. |
Definition at line 187 of file CaeStrBoundary.h.
References group_.
Referenced by CaeStrBoundary(), moveFirst(), moveNext(), movePrev(), operator++(), and operator--().
|
inline |
Rebinds an instance to a specific boundary within the current group.
ndx | The boundary's index in the group's index space. |
Definition at line 200 of file CaeStrBoundary.h.
References CaeStrBoundaryGroup::enumBoundaries(), group_, groupNdx_, and h_.
|
inline |
|
inline |
Compares two CaeStrBoundary instances for inequality.
Definition at line 324 of file CaeStrBoundary.h.
|
inline |
Prefix increment to the next boundary in the group.
Definition at line 253 of file CaeStrBoundary.h.
|
inline |
Postfix increment to the next boundary in the group.
Definition at line 264 of file CaeStrBoundary.h.
|
inline |
Prefix decrement to the previous boundary in the group.
Definition at line 289 of file CaeStrBoundary.h.
|
inline |
Postfix decrement to the previous boundary in the group.
Definition at line 300 of file CaeStrBoundary.h.
|
inline |
Compares the relative order of two CaeStrBoundary instances.
Definition at line 336 of file CaeStrBoundary.h.
|
inline |
Assignment operator.
Rebind this boundary to the same boundary as rhs.
rhs | A boundary instance. |
Definition at line 172 of file CaeStrBoundary.h.
|
inline |
Compares two CaeStrBoundary instances for equality.
Definition at line 315 of file CaeStrBoundary.h.
|
inline |
Compares the relative order of two CaeStrBoundary instances.
Definition at line 350 of file CaeStrBoundary.h.
|
protected |
The owning boundary group.
Definition at line 362 of file CaeStrBoundary.h.
Referenced by CaeStrBoundary(), moveFirst(), moveTo(), operator<(), operator=(), and operator==().
|
protected |
The current index in the group's index space.
Definition at line 364 of file CaeStrBoundary.h.
Referenced by CaeStrBoundary(), index(), moveFirst(), moveNext(), movePrev(), moveTo(), operator++(), operator--(), and operator=().
|
protected |
The bound PWGM_HBNDRY.
Definition at line 363 of file CaeStrBoundary.h.
Referenced by CaeStrBoundary(), data(), isValid(), model(), modelIndex(), moveFirst(), moveTo(), operator PWGM_HBNDRY(), operator<(), operator=(), and operator==().