Go to the documentation of this file.
10 #ifndef _CAEGRIDMODEL_H_
11 #define _CAEGRIDMODEL_H_
95 bool getAttribute(
const char *name,
const char *&val,
const char *defVal)
const;
102 bool getAttribute(
const char *name,
bool &val,
bool defVal)
const;
103 bool getAttributeEnum(
const char *name,
const char *&val,
const char *defVal)
const;
125 template<
typename T >
bool isUnspecified() const
Returns true if either or both of the condition's types is unspecified.
#define PWGM_HBLOCK_ID(h)
gets the block's guid from the handle
bool operator>(const PWGM_HBLOCK &h1, const PWGM_HBLOCK &h2)
bool getAttribute(const char *name, PWP_UINT32 &val, PWP_UINT32 defVal) const
static const PWP_UINT32 UnspecifiedId
The reserved "unspecified" condition Id value.
PWP_UINT32 blockCount() const
Get the number of blocks in the model.
CaeBlock()
Default constructor.
bool hasUnspecifiedType() const
Returns true if the condition's type id is UnspecifiedTypeId.
bool getAttributeEnum(const char *name, const char *&val, const char *defVal) const
CaeGridModel(PWGM_HGRIDMODEL model)
Constructor.
PWP_UINT32 id
grid-defined condition id
PWP_UINT32 tid
cae-defined condition id
PWP_BOOL PwBlock(PWGM_HBLOCK block, PWGM_BLOCKDATA *pBlockData)
Get the block data.
CaeBlock & movePrev()
Rebinds an instance to the previous block in a model.
#define PWGM_HBLOCK_H(h)
gets the element's parent PWGM_HGRIDMODEL handle
const char * name
grid-defined condition name
bool operator<(const PWGM_HBLOCK &h1, const PWGM_HBLOCK &h2)
An opaque handle to a grid model.
bool hasUnspecifiedId() const
Returns true if the condition's user id is UnspecifiedId.
The grid model base class.
CaeBlock(PWGM_HGRIDMODEL model, PWP_UINT32 ndx=0)
Model and block index constructor.
bool setExportName(const char *name)
Set the name used to identify the block or group of blocks in the exported grid.
PWGM_HBLOCK block_
The bound PWGM_HBLOCK.
#define PWGM_HBLOCK_ISVALID(h)
Returns non-zero value if handle is valid.
bool operator==(const CaeBlock &rhs) const
Compares two CaeBlock instances for equality.
const char * type
cae-defined condition physical type name
Pointwise Grid Model API Specification (PWGM-API)
CaeCondition & operator=(const PWGM_CONDDATA &cd)
Assignment operator.
CaeBlock & operator++()
Prefix increment to the next block in a model.
const char * name() const
Gets the user assigned condition name.
bool operator==(const PWGM_HBLOCK &h1, const PWGM_HBLOCK &h2)
CaeBlock & operator=(PWGM_HBLOCK block)
Assignment operator.
PWP_BOOL PwBlkCondition(PWGM_HBLOCK block, PWGM_CONDDATA *pCondData)
Get the block condition data.
CaeCondition(const CaeCondition &src)
Copy constructor.
CaeCondition()
Default constructor.
CaeBlock operator++(int)
Postfix increment to the next block in a model.
bool getAttribute(const char *name, PWP_INT32 &val, PWP_INT32 defVal) const
CaeBlock & operator--()
Prefix decrement to the previous block in a model.
CaeBlock & operator=(const CaeBlock &rhs)
Assignment operator.
An opaque handle to a grid block element.
bool isValid() const
Determines a block's validity.
CaeBlock(const CaeBlock &src)
Copy constructor.
bool data(PWGM_BLOCKDATA &data)
Get the block data.
CaeBlock & moveTo(PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
Rebinds an instance to a specific model block.
bool getAttribute(const char *name, const char *&val, const char *defVal) const
Condition descriptor data type.
bool getAttribute(const char *name, T &val) const
Templated method that gets the value of a published plugin attribute.
PWGM_HBLOCK PwModEnumBlocks(PWGM_HGRIDMODEL model, PWP_UINT32 ndx)
Sequentially enumerate the model block elements.
CaeCondition & operator=(const CaeCondition &src)
Assignment operator.
CaeBlock(PWGM_HBLOCK block)
Block handle constructor.
const char * typeName() const
Gets the solver defined condition type name.
PWP_UINT32 typeId() const
Gets the solver defined condition type id value.
#define PWGM_UNSPECIFIED_TYPE_ID
The Unspecified physical type id.
Pointwise Plugin API (PWP-API)
CaeGridModel & operator=(const CaeGridModel &rhs)
The assignment operator.
~CaeGridModel()
Destructor.
PWGM_CONDDATA cd_
The condition data struct.
PWP_UINT32 id() const
Gets the user assigned condition id value.
CaeCondition(const PWGM_CONDDATA &cd)
Cast/Copy constructor.
PWP_UINT32 index() const
Get a block's index.
static const PWP_UINT32 UnspecifiedTypeId
The reserved "unspecified" condition TypeId value.
The grid block base class.
#define PWGM_UNSPECIFIED_COND_ID
The id of the global, Unspecified condition descriptor.
CaeBlock & moveNext()
Rebinds an instance to the next block in a model.
CaeBlock & moveFirst(PWGM_HGRIDMODEL model)
Rebinds an instance to the first block in a model.
The volume and boundary condition data class.
~CaeCondition()
Destructor.
bool operator!=(const PWGM_HBLOCK &h1, const PWGM_HBLOCK &h2)
PWGM_HGRIDMODEL model_
The bound PWGM_HGRIDMODEL.
bool isOfType(PWP_UINT32 tid) const
Returns true if condition is of the specified type id.
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.
bool condition(PWGM_CONDDATA &condData) const
Gets the block's condition data.
CaeBlock operator--(int)
Postfix decrement to the previous block in a model.