CaeStrBoundary.h

Go to the documentation of this file.

/****************************************************************************
 *
 * CaeStrBoundary class
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#if !defined(PWGM_HIDE_STRUCTURED_API)
 
#ifndef _CAESTRBOUNDARY_H_
#define _CAESTRBOUNDARY_H_
 
#include "apiGridModel.h"
#include "apiPWP.h"
#include "CaeStrBoundaryGroup.h"
#include "CaeStrGridModel.h"
 
 
class CaeStrBoundary {
public:
 
 
    CaeStrBoundary() : group_(0), groupNdx_(0) {
        PWGM_HBNDRY_SET_INVALID(h_);
    }
 
 
    CaeStrBoundary(const CaeStrBoundaryGroup &group, PWP_UINT32 ndx = 0) {
        PWGM_HBNDRY_SET_INVALID(h_);
        moveTo(group, ndx);
    }
 
 
    CaeStrBoundary(const CaeStrBoundary &src) {
        group_ = src.group_;
        h_ = src.h_;
        groupNdx_ = src.groupNdx_;
    }
 
    ~CaeStrBoundary() {
    }
 
    CaeStrGridModel model() const {
        return CaeStrGridModel(PWGM_HBNDRY_MODEL(h_));
    }
 
 
    PWP_UINT32 index() const {
        return groupNdx_;
    }
 
 
    PWP_UINT32 modelIndex() const {
        return PWGM_HBNDRY_ID(h_);
    }
 
 
    bool data(PWGM_BNDRYDATA &data) const {
        return 0 != PwBoundary(h_, &data);
    }
 
 
    bool data(PWGM_CONDDATA &data) const {
        return 0 != PwBndryCondition(h_, &data);
    }
 
 
    bool data(PWGM_BNDRYDATA &bData, PWGM_CONDDATA &cData) const {
        return 0 != PwModNdxBoundaryAndCondition(PWGM_HBNDRY_MODEL(h_),
                        PWGM_HBNDRY_ID(h_), &bData, &cData);
    }
 
    bool isValid() const {
        return PWGM_HBNDRY_ISVALID(h_);
    }
 
 
    CaeStrBoundary& operator=(const CaeStrBoundary& rhs) {
        group_ = rhs.group_;
        h_ = rhs.h_;
        groupNdx_ = rhs.groupNdx_;
        return *this;
    }
 
 
    CaeStrBoundary& moveTo(const CaeStrBoundaryGroup &group, PWP_UINT32 ndx) {
        group_ = &group;
        return moveTo(ndx);
    }
 
 
    CaeStrBoundary& moveTo(PWP_UINT32 ndx) {
        if (0 != group_) {
            groupNdx_ = ndx;
            h_ = group_->enumBoundaries(groupNdx_);
        }
        return *this;
    }
 
 
    CaeStrBoundary& moveFirst(const CaeStrBoundaryGroup &group) {
        group_ = &group;
        return moveTo(0);
    }
 
 
    CaeStrBoundary& moveFirst() {
        groupNdx_ = 0;
        if (0 != group_) {
            h_ = group_->enumBoundaries(groupNdx_);
        }
        return *this;
    }
 
 
    CaeStrBoundary& moveNext() {
        return moveTo(groupNdx_ + 1);
    }
 
 
    CaeStrBoundary& operator++() {
        return moveTo(groupNdx_ + 1);
    }
 
 
    CaeStrBoundary operator++(int) {
        CaeStrBoundary ret = *this;
        moveTo(groupNdx_ + 1);
        return ret;
    }
 
 
    CaeStrBoundary& movePrev() {
        return moveTo(groupNdx_ - 1);
    }
 
 
    CaeStrBoundary& operator--() {
        return moveTo(groupNdx_ - 1);
    }
 
 
    CaeStrBoundary operator--(int) {
        CaeStrBoundary ret = *this;
        moveTo(groupNdx_ - 1);
        return ret;
    }
 
    friend bool operator==(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
 
 
    bool operator==(const CaeStrBoundary &rhs) const {
        return (rhs.group_ == group_) && (rhs.h_ == h_);
    }
 
 
    bool operator!=(const CaeStrBoundary &rhs) const {
        return !(rhs == *this);
    }
 
    friend bool operator<(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
 
 
    bool operator<(const CaeStrBoundary &rhs) const {
        if (rhs.group_ < group_) {
            return true;
        }
        else if (rhs.group_ > group_) {
            return false;
        }
        return h_ < rhs.h_;
    }
 
 
    bool operator>(const PWGM_HBNDRY &rhs)
    {
        return !(*this == rhs) && !(*this < rhs);
    }
 
    operator PWGM_HBNDRY() const {
        return h_;
    }
 
protected:
 
    const CaeStrBoundaryGroup * group_;     
    PWGM_HBNDRY                 h_;         
    PWP_UINT32                  groupNdx_;  
};
 
#endif // _CAESTRBOUNDARY_H_
 
#endif // PWGM_HIDE_STRUCTURED_API