Pointwise Plugin SDK
CaeStrConnectionGroup.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * CaeStrConnectionGroup class
4  *
5  * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
6  *
7  ***************************************************************************/
8 
9 #if !defined(PWGM_HIDE_STRUCTURED_API)
10 
11 #ifndef _CAESTRCONNECTIONGROUP_H_
12 #define _CAESTRCONNECTIONGROUP_H_
13 
14 
15 #include "apiGridModel.h"
16 #include "apiPWP.h"
17 
18 
46 public:
47 
50  {
51  }
52 
54 
58  return this->connectionCountImpl();
59  }
60 
62 
69  return this->enumConnectionsImpl(ndx);
70  }
71 
73 
80  return this->enumConnectionsImpl(0);
81  }
82 
83 protected:
84 
86 
91  virtual PWP_UINT32 connectionCountImpl() const = 0;
92 
94 
102  virtual PWGM_HCNXN enumConnectionsImpl(PWP_UINT32 ndx) const = 0;
103 };
104 
105 #endif // _CAESTRCONNECTIONGROUP_H_
106 
107 #endif // PWGM_HIDE_STRUCTURED_API
CaeStrConnectionGroup::enumConnections
PWGM_HCNXN enumConnections(PWP_UINT32 ndx) const
Get an connection in the group.
Definition: CaeStrConnectionGroup.h:68
CaeStrConnectionGroup::connectionCount
PWP_UINT32 connectionCount() const
Get the number of connections in the group.
Definition: CaeStrConnectionGroup.h:57
PWP_UINT32
unsigned int PWP_UINT32
32-bit unsigned integer
Definition: apiPWP.h:210
CaeStrConnectionGroup::enumConnectionsImpl
virtual PWGM_HCNXN enumConnectionsImpl(PWP_UINT32 ndx) const =0
Get a connection in the group.
CaeStrConnectionGroup::connectionCountImpl
virtual PWP_UINT32 connectionCountImpl() const =0
Get the number of connections in the group.
PWGM_HCNXN
An opaque handle to a structured, inter-block connection.
Definition: apiGridModel.h:482
apiGridModel.h
Pointwise Grid Model API Specification (PWGM-API)
CaeStrConnectionGroup::firstConnection
PWGM_HCNXN firstConnection() const
Get the first connection in the group.
Definition: CaeStrConnectionGroup.h:79
CaeStrConnectionGroup
The structured block to block connection group class.
Definition: CaeStrConnectionGroup.h:45
CaeStrConnectionGroup::~CaeStrConnectionGroup
virtual ~CaeStrConnectionGroup()
Destructor.
Definition: CaeStrConnectionGroup.h:49
apiPWP.h
Pointwise Plugin API (PWP-API)