Pointwise Plugin SDK
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
CaeCondition Class Reference
The Fidelity Pointwise Grid Model API » Using C++ » Fidelity Pointwise C++ Grid Model Base Classes

The volume and boundary condition data class. More...

#include <CaeGridModel.h>

+ Collaboration diagram for CaeCondition:

Public Member Functions

 CaeCondition ()
 Default constructor. More...
 
 CaeCondition (const CaeCondition &src)
 Copy constructor. More...
 
 CaeCondition (const PWGM_CONDDATA &cd)
 Cast/Copy constructor. More...
 
bool hasUnspecifiedId () const
 Returns true if the condition's user id is UnspecifiedId. More...
 
bool hasUnspecifiedType () const
 Returns true if the condition's type id is UnspecifiedTypeId. More...
 
PWP_UINT32 id () const
 Gets the user assigned condition id value. More...
 
bool isOfType (PWP_UINT32 tid) const
 Returns true if condition is of the specified type id. More...
 
bool isUnspecified () const
 Returns true if either or both of the condition's types is unspecified. More...
 
const char * name () const
 Gets the user assigned condition name. More...
 
 operator const PWGM_CONDDATA & () const
 Const PWGM_CONDDATA casting operator. More...
 
 operator PWGM_CONDDATA & ()
 Non-const PWGM_CONDDATA casting operator. More...
 
CaeCondition & operator= (const CaeCondition &src)
 Assignment operator. More...
 
CaeCondition & operator= (const PWGM_CONDDATA &cd)
 Assignment operator. More...
 
PWP_UINT32 typeId () const
 Gets the solver defined condition type id value. More...
 
const char * typeName () const
 Gets the solver defined condition type name. More...
 
 ~CaeCondition ()
 Destructor. More...
 

Static Public Attributes

static const PWP_UINT32 UnspecifiedId = PWP_UINT32(2147483647)
 The reserved "unspecified" condition Id value. More...
 
static const PWP_UINT32 UnspecifiedTypeId = PWP_UINT32(0)
 The reserved "unspecified" condition TypeId value. More...
 

Private Attributes

PWGM_CONDDATA cd_
 The condition data struct. More...
 

Detailed Description

The volume and boundary condition data class.

The CaeCondition class represents the data available for both volume and boundary conditions. This class's data is populated with a call to one of the CaeStrBlock::condition(), CaeUnsBlock::condition() or CaeUnsPatch::condition() methods.

See also
CaeStrBlock::condition(), CaeUnsBlock::condition(), CaeUnsPatch::condition(), PWGM_CONDDATA
Sample Usage:
CaeCondition vc;
CaeUnsBlock blk(model_);
while (blk.isValid()) {
std::cout << "block: " << blk.index() << std::endl;
if (blk.condition(vc)) {
std::cout << " VC name: " << vc.name() << std::endl;
std::cout << " VC id: " << vc.id() << std::endl;
std::cout << " VC typeName: " << vc.typeName() << std::endl;
std::cout << " VC typeId: " << vc.typeId() << std::endl;
}
++blk;
}

Definition at line 450 of file CaeGridModel.h.

Constructor & Destructor Documentation

◆ CaeCondition() [1/3]

CaeCondition::CaeCondition ( )
inline

Default constructor.

Constructs an "unspecified" condition data object.

See also
CaeUnsBlock::condition(), CaeUnsPatch::condition()

Definition at line 466 of file CaeGridModel.h.

References cd_, PWGM_CONDDATA::id, PWGM_CONDDATA::name, PWGM_CONDDATA::tid, PWGM_CONDDATA::type, UnspecifiedId, and UnspecifiedTypeId.

◆ CaeCondition() [2/3]

CaeCondition::CaeCondition ( const CaeCondition &  src)
inline

Copy constructor.

Definition at line 476 of file CaeGridModel.h.

References cd_.

◆ CaeCondition() [3/3]

CaeCondition::CaeCondition ( const PWGM_CONDDATA &  cd)
inline

Cast/Copy constructor.

Definition at line 483 of file CaeGridModel.h.

References cd_.

◆ ~CaeCondition()

CaeCondition::~CaeCondition ( )
inline

Destructor.

Definition at line 490 of file CaeGridModel.h.

Member Function Documentation

◆ hasUnspecifiedId()

bool CaeCondition::hasUnspecifiedId ( ) const
inline

Returns true if the condition's user id is UnspecifiedId.

Definition at line 537 of file CaeGridModel.h.

References cd_, PWGM_CONDDATA::id, and UnspecifiedId.

Referenced by isUnspecified().

◆ hasUnspecifiedType()

bool CaeCondition::hasUnspecifiedType ( ) const
inline

Returns true if the condition's type id is UnspecifiedTypeId.

Definition at line 545 of file CaeGridModel.h.

References cd_, PWGM_CONDDATA::tid, and UnspecifiedTypeId.

Referenced by isUnspecified().

◆ id()

PWP_UINT32 CaeCondition::id ( ) const
inline

Gets the user assigned condition id value.

Definition at line 505 of file CaeGridModel.h.

References cd_, and PWGM_CONDDATA::id.

◆ isOfType()

bool CaeCondition::isOfType ( PWP_UINT32  tid) const
inline

Returns true if condition is of the specified type id.

Definition at line 529 of file CaeGridModel.h.

References cd_, and PWGM_CONDDATA::tid.

◆ isUnspecified()

bool CaeCondition::isUnspecified ( ) const
inline

Returns true if either or both of the condition's types is unspecified.

Equivalent to calling hasUnspecifiedId() || hasUnspecifiedType().

See also
hasUnspecifiedId(), hasUnspecifiedType()

Definition at line 557 of file CaeGridModel.h.

References hasUnspecifiedId(), and hasUnspecifiedType().

◆ name()

const char* CaeCondition::name ( ) const
inline

Gets the user assigned condition name.

Definition at line 497 of file CaeGridModel.h.

References cd_, and PWGM_CONDDATA::name.

◆ operator const PWGM_CONDDATA &()

CaeCondition::operator const PWGM_CONDDATA & ( ) const
inline

Const PWGM_CONDDATA casting operator.

Definition at line 587 of file CaeGridModel.h.

References cd_.

◆ operator PWGM_CONDDATA &()

CaeCondition::operator PWGM_CONDDATA & ( )
inline

Non-const PWGM_CONDDATA casting operator.

Definition at line 580 of file CaeGridModel.h.

References cd_.

◆ operator=() [1/2]

CaeCondition& CaeCondition::operator= ( const CaeCondition &  src)
inline

Assignment operator.

Definition at line 564 of file CaeGridModel.h.

References cd_.

◆ operator=() [2/2]

CaeCondition& CaeCondition::operator= ( const PWGM_CONDDATA &  cd)
inline

Assignment operator.

Definition at line 572 of file CaeGridModel.h.

References cd_.

◆ typeId()

PWP_UINT32 CaeCondition::typeId ( ) const
inline

Gets the solver defined condition type id value.

Definition at line 521 of file CaeGridModel.h.

References cd_, and PWGM_CONDDATA::tid.

◆ typeName()

const char* CaeCondition::typeName ( ) const
inline

Gets the solver defined condition type name.

Definition at line 513 of file CaeGridModel.h.

References cd_, and PWGM_CONDDATA::type.

Member Data Documentation

◆ cd_

PWGM_CONDDATA CaeCondition::cd_
private

The condition data struct.

Definition at line 595 of file CaeGridModel.h.

Referenced by CaeCondition(), hasUnspecifiedId(), hasUnspecifiedType(), id(), isOfType(), name(), operator const PWGM_CONDDATA &(), operator PWGM_CONDDATA &(), operator=(), typeId(), and typeName().

◆ UnspecifiedId

const PWP_UINT32 CaeCondition::UnspecifiedId = PWP_UINT32(2147483647)
static

The reserved "unspecified" condition Id value.

Definition at line 454 of file CaeGridModel.h.

Referenced by CaeCondition(), and hasUnspecifiedId().

◆ UnspecifiedTypeId

const PWP_UINT32 CaeCondition::UnspecifiedTypeId = PWP_UINT32(0)
static

The reserved "unspecified" condition TypeId value.

Definition at line 457 of file CaeGridModel.h.

Referenced by CaeCondition(), and hasUnspecifiedType().

The documentation for this class was generated from the following file:
CaeUnsBlock
The unstructured block class.
Definition: CaeUnsBlock.h:68
CaeCondition::name
const char * name() const
Gets the user assigned condition name.
Definition: CaeGridModel.h:497
CaeCondition::typeName
const char * typeName() const
Gets the solver defined condition type name.
Definition: CaeGridModel.h:513
CaeCondition::typeId
PWP_UINT32 typeId() const
Gets the solver defined condition type id value.
Definition: CaeGridModel.h:521
CaeCondition::id
PWP_UINT32 id() const
Gets the user assigned condition id value.
Definition: CaeGridModel.h:505
CaeCondition
The volume and boundary condition data class.
Definition: CaeGridModel.h:450