oaOccBusNetDef Class Reference
Inheritance diagram for oaOccBusNetDef:
Detailed Description
The oaOccBusNetDef class implements the definition of an occurrence busNet, including its base name and bit-range. All busNets in an occurrence with the same base name are managed by the same busNet definition. The oaOccBusNetDef class tracks the minimum and maximum indices referred to by all of its corresponding busNet and busNetBit objects.
The bit order of an explicit oaOccBusNetDef is independent of the order within individual oaOccBusNets with the same base name. Verilog requires a single wire declaration for a given base name, and the range of that declaration covers all of the bit indices used by the sub-ranges that correspond to oaOccBusNets.
A busNetDef can be 'sparse' (have missing bits). Busses do not have to start or end at zero. For example, a<22:25> is a legal bus name. Bus indexes must be non-negative.
The oaOccBusNetDef class can be observed by deriving from oaObserver<oaOccBusNetDef>.
Member Function Documentation
|
|
This function searches the specified occurrence looking for a busNetDef with the specified baseName. If baseName is hierarchical, this function will descend into lower levels of occurrence hierarchy, expanding the hierarchy and binding the master designs as needed. The busNetDef is returned if found, otherwise NULL is returned.
- Parameters:
-
| occurrence | The occurrence in which to search |
| baseName | The base name of the busNetDef to find |
- Returns:
- A pointer to the oaOccBusNetDef
|
|
|
This function returns the bitOrder associated with this oaOccBusNetDef. |
|
|
This function returns a collection of oaOccBusNetBit objects in this oaOccBusNetDef object. |
|
|
This function returns a collection of oaOccBusNet objects in this oaOccBusNetDef object. |
| oaUInt4 oaOccBusNetDef::getMaxIndex |
( |
|
) |
const |
|
|
|
This function returns the largest bit number in use for this oaOccBusNetDef object. This is the largest index used across all busNets associated with this oaOccBusNetDef object. |
| oaUInt4 oaOccBusNetDef::getMinIndex |
( |
|
) |
const |
|
|
|
This function returns the smallest bit number in use for this oaOccBusNetDef object. This is the smallest index used across all busNets associated with this oaOccBusNetDef object. |
|
|
This function returns the local name of this busNetDef in the specified nameSpace in the specified name string. The name is relative to the parent occurrence of this busNetDef.
- Parameters:
-
| ns | The nameSpace used to map the name |
| name | The returned busNetDef name |
|
|
|
This function returns the local name of this busNetDef within its parent occurrence.
- Parameters:
-
| name | The returned busNetDef name |
|
| oaUInt4 oaOccBusNetDef::getNumBits |
( |
|
) |
const |
|
|
|
This function returns the number of bits covered by the busses in this oaOccBusNetDef. The number of bits is equal to abs(MSB - LSB) + 1; it is not necessarily the number of busNetBits present in this busNetDef. To get the number of busNetBits in this busnetDef, use oaOccBusNetDef::getBusNetBits().getCount() |
|
|
This function returns the full path name of this busNetDef in the specified nameSpace in the specified pathName string. The pathName is relative to the top occurrence in the occurrence hierarchy containing this busNetDef.
- Parameters:
-
| ns | The nameSpace used to map the name |
| pathName | The returned path name |
|
| void oaOccBusNetDef::getPathName |
( |
oaScalarName & |
pathName |
) |
const |
|
|
|
This function returns the full path name of this busNetDef, relative to the top occurrence in the occurrence hierarchy containing this busNetDef.
- Parameters:
-
| pathName | The returned path name |
|
| void oaOccBusNetDef::isImplicit |
( |
|
) |
const |
|
|
|
This function returns a boolean indicating whether this oaOccBusNetDef was implicitly created or not. |
Member Enumeration Documentation
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.
