CaeStrConnection.h

Go to the documentation of this file.

/****************************************************************************
 *
 * CaeStrConnection class
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#if !defined(PWGM_HIDE_STRUCTURED_API)
 
#ifndef _CAESTRCONNECTION_H_
#define _CAESTRCONNECTION_H_
 
#include "apiGridModel.h"
#include "apiPWP.h"
#include "CaeStrConnectionGroup.h"
#include "CaeStrGridModel.h"
 
 
class CaeStrConnection {
public:
 
 
    CaeStrConnection() : group_(0), groupNdx_(0) {
        PWGM_HCNXN_SET_INVALID(h_);
    }
 
 
    CaeStrConnection(const CaeStrConnectionGroup &group, PWP_UINT32 ndx = 0) {
        PWGM_HCNXN_SET_INVALID(h_);
        moveTo(group, ndx);
    }
 
 
    CaeStrConnection(const CaeStrConnection &src) {
        group_ = src.group_;
        h_ = src.h_;
        groupNdx_ = src.groupNdx_;
    }
 
    ~CaeStrConnection() {
    }
 
    CaeStrGridModel model() const {
        return CaeStrGridModel(PWGM_HCNXN_MODEL(h_));
    }
 
 
    PWP_UINT32 index() const {
        return groupNdx_;
    }
 
 
    PWP_UINT32 modelIndex() const {
        return PWGM_HCNXN_ID(h_);
    }
 
 
    bool data(PWGM_CNXNDATA &data) const {
        return 0 != PwConnection(h_, &data);
    }
 
    bool isValid() const {
        return PWGM_HCNXN_ISVALID(h_);
    }
 
 
    CaeStrConnection& operator=(const CaeStrConnection& rhs) {
        group_ = rhs.group_;
        h_ = rhs.h_;
        groupNdx_ = rhs.groupNdx_;
        return *this;
    }
 
 
    CaeStrConnection& moveTo(const CaeStrConnectionGroup &group, PWP_UINT32 ndx) {
        group_ = &group;
        return moveTo(ndx);
    }
 
 
    CaeStrConnection& moveTo(PWP_UINT32 ndx) {
        if (0 != group_) {
            groupNdx_ = ndx;
            h_ = group_->enumConnections(groupNdx_);
        }
        return *this;
    }
 
 
    CaeStrConnection& moveFirst(const CaeStrConnectionGroup &group) {
        group_ = &group;
        return moveTo(0);
    }
 
 
    CaeStrConnection& moveFirst() {
        groupNdx_ = 0;
        if (0 != group_) {
            h_ = group_->enumConnections(groupNdx_);
        }
        return *this;
    }
 
 
    CaeStrConnection& moveNext() {
        return moveTo(groupNdx_ + 1);
    }
 
 
    CaeStrConnection& operator++() { // pre incr to next element
        return moveTo(groupNdx_ + 1);
    }
 
 
    CaeStrConnection operator++(int) { // post incr to next element
        CaeStrConnection ret = *this;
        moveTo(groupNdx_ + 1);
        return ret;
    }
 
 
    CaeStrConnection& movePrev() { // move to previous element
        return moveTo(groupNdx_ - 1);
    }
 
 
    CaeStrConnection& operator--() { // pre decr to previous element
        return moveTo(groupNdx_ - 1);
    }
 
 
    CaeStrConnection operator--(int) { // post decr to previous element
        CaeStrConnection ret = *this;
        moveTo(groupNdx_ - 1);
        return ret;
    }
 
    friend bool operator==(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
 
 
    bool operator==(const CaeStrConnection &rhs) const {
        return (rhs.group_ == group_) && (rhs.h_ == h_);
    }
 
 
    bool operator!=(const CaeStrConnection &rhs) const {
        return !(rhs == *this);
    }
 
    friend bool operator<(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
 
 
    bool operator<(const CaeStrConnection &rhs) const {
        if (rhs.group_ < group_) {
            return true;
        }
        else if (rhs.group_ > group_) {
            return false;
        }
        return h_ < rhs.h_;
    }
 
 
    bool operator>(const PWGM_HCNXN &rhs)
    {
        return !(*this == rhs) && !(*this < rhs);
    }
 
    operator PWGM_HCNXN() const {
        return h_;
    }
 
protected:
 
    const CaeStrConnectionGroup *   group_;     
    PWGM_HCNXN                      h_;         
    PWP_UINT32                      groupNdx_;  
};
 
#endif // _CAESTRCONNECTION_H_
 
#endif // PWGM_HIDE_STRUCTURED_API