oaModBundleTerm Class Reference
Inheritance diagram for oaModBundleTerm:
Detailed Description
The oaModBundleTerm class implements a multi-bit terminal for an oaModule. It is composed of a list of scalarTerms and busTerms and repeated copies of those elements. When a bundleTerm is created, the constituent scalarTerms and busNetBits are automatically created if they do not already exist. oaModBundleTerm objects are associated with oaModNets that may be oaModBundleNets but aren't required to be. The number of bits implied by the names of the oaModBundleTerm and its oaModNet must match to be valid.
oaModBundleTerm, oaOccBundleTerm, and oaBundleTerm each represent bundle terminals in a different hierarchy domain, where in each case the master represents a level of hierarchy in the design.
For oaModBundleTerm, the master is an oaModule, and each module in a cellview will have a set of zero or more modBundleTerms. For oaOccBundleTerm, the master is an oaOccurrence.
For oaBundleTerm, the master is an oaBlock, and the top block for the cellView will have a set of zero or more bundleTerms. In the typical case where all block objects are visible to the module domain, the oaModBundleTerms on the top oaModule will have corresponding oaBundleTerms on the top oaBlock. All of the oaModBundleTerms on the top module have a corresponding oaOccBundleTerm on the top oaOccurrence.
Member Function Documentation
|
|
This function adds a new oaModBundleTerm to the specified modNet. The bundle name must imply the same number of bits as the width of the modNet.
- Parameters:
-
| modNet | A pointer to the modNet to associate with the terminal; the bits of the modNet are associated with the constituent bits of the automatically created member terminals |
| name | The name of the terminal |
| termType | The type of the terminal to create |
- Exceptions:
-
|
| oaModBundleTerm * oaModBundleTerm::find |
( |
const oaModule * |
module, |
|
|
const oaBundleName & |
name |
|
) |
[static] |
|
|
|
This function searches the specified module for a bundleTerm with the given name. The bundleTerm is returned if it exists. Otherwise, NULL is returned.
- Parameters:
-
| module | The module to search |
| name | The name of the terminal |
- Returns:
- A pointer to an oaModBundleTerm if found; otherwise, NULL is returned
|
|
|
This function returns the memIndex member of this bundleTerm.
- Parameters:
-
| memIndex | The bundle member index of the member term to get |
- Returns:
- A pointer to an oaModTerm
- Exceptions:
-
|
|
|
This function returns a collection of member terms in this bundleTerm. |
|
|
This function fills in name with the name of this terminal mapped to the specified nameSpace. |
| void oaModTerm::getName |
( |
oaName & |
name |
) |
const |
|
|
|
This function fills out name with the name of this terminal. |
|
|
This function returns the name of this modBundleTerm.
- Parameters:
-
| name | The name of the modBundleTerm to return |
|
| oaUInt4 oaModBundleTerm::getNumMembers |
( |
|
) |
const |
|
|
|
This function returns the number of members in this bundleTerm.
- Returns:
- The number of member terminals in this bundleTerm
|
|
|
This function returns a boolean value that indicates if the specified name is valid for a new oaModBundleTerm object associated with the specified net.
- Parameters:
-
| module | The module in which to create the new bundle terminal |
| net | The net with which to associate the new bundle terminal |
| name | The name of the new bundle terminal |
|
The documentation for this class was generated from the following files:
Return to top of page
Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.
