oaBusNetDef Class Reference
Inheritance diagram for oaBusNetDef:
Detailed Description
The oaBusNetDef class implements the definition of a busNet, including its base name and bit-range. All busNets and busNetBits in a block with the same base name are managed by the same busNet definition. The oaBusNetDef class tracks the minimum and maximum indices referred to by all of its corresponding oaBusNetBit objects.
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.
An oaBusNetDef is automatically created if necessary whenever applications create busNets. Implicitly created busNet definitions have no bitOrder. Applications may explicitly create a busNet definition in order to specify that it has a specific bitOrder.
The bit order of an explicit oaBusNetDef is independent of the order within individual oaBusNets 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 oaBusNets.
Implicitly created busNet definitions are automatically destroyed when the last busNet with the same base name is destroyed. Explicitly created busNet definitions must be explicitly destroyed.
The oaBusNetDef class can be observed by deriving from oaObserver<oaBusNetDef>.
Member Function Documentation
|
|
This function creates an oaBusNetDef in the specified block with the given base name and bit order. An exception is thrown if an oaBusNetDef already exists with the specified name. Explicitly creating an oaBusNetDef also means that the busNet definition must be explicitly destroyed.
The bit order of an explicit oaBusNetDef is independent of the order within individual oaBusNets 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 oaBusNets. If the name is hierarchical, the oaBusNetDef is created if:
- The path already exists
- No oaOccScalarNet with this name exists in the specified occurrence
- No explicit oaOccBusNetDef with this name exists in the specified occurrence (implicit oaOccBusNetDefs are not considered)
- Parameters:
-
| block | The block to create the oaBusNetDef object in |
| name | The base name for the oaBusNetDef |
| order | The bit order for the oaBusNetDef |
- Exceptions:
-
|
| void oaBusNetDef::destroy |
( |
|
) |
|
|
|
|
This function destroys this oaBusNetDef, removing it from the database. An exception is thrown if the oaBusNetDef is implicit or if there are still oaBusNets associated with it.
- Exceptions:
-
|
|
|
This function searches the specified block for an oaBusNetDef with the specified name. The oaBusNetDef is returned if found. Otherwise, NULL is returned. If the name is hierarchical and an oaOccBusNetDef with that name can be found, and the oaOccBusNetDef is published in the block domain, the block domain reflection of that oaOccBusNetDef is returned. If the occBusNetDef is not published in the block domain, NULL is returned.
- Parameters:
-
| block | The block to search for the oaBusNetDef object |
| name | The name of the oaBusNetDef to find |
|
|
|
This function returns the bitOrder associated with this oaBusNetDef object. |
|
|
This function returns a collection of oaBusNetBit objects in this oaBusNetDef object. |
|
|
This function returns a collection of oaBusNet objects in this oaBusNetDef object. |
| oaUInt4 oaBusNetDef::getMaxIndex |
( |
|
) |
const |
|
|
|
This function returns the largest bit number in use for this oaBusNetDef object. This is the largest index used across all busNets associated with this oaBusNetDef object. |
| oaUInt4 oaBusNetDef::getMinIndex |
( |
|
) |
const |
|
|
|
This function returns the smallest bit number in use for this oaBusNetDef object. This is the smallest index used across all busNets associated with this oaBusNetDef object. |
|
|
This function returns the name string of this oaBusNetDef object in the specified nameSpace.
- Parameters:
-
| ns | The nameSpace to use when getting the name string |
| name | Returns the string name of this oaBusNetDef |
|
|
|
This function returns the name of this oaBusNetDef object.
- Parameters:
-
| name | The scalar name in which to return the oaBusNetDef object name |
|
| oaUInt4 oaBusNetDef::getNumBits |
( |
|
) |
const |
|
|
|
This function returns the number of bits covered by the busses in this oaBusNetDef. The number of bits is equal to abs(maxIndex - minIndex) + 1; it is not necessarily the number of busNetBits present in this busNetDef. To get the number of busNetBits in this busnetDef, use oaBusNetDef::getBusNetBits().getCount(). |
|
|
This function returns a collection of oaOccBusNetBits in this oaBusNetDef. |
|
|
This function returns a collection of oaOccBusNets in this oaBusNetDef. |
| void oaBusNetDef::isImplicit |
( |
|
) |
const |
|
|
|
This function returns a boolean indicating whether this oaBusNetDef was implicitly created or not. |
| void oaBusNetDef::setBitOrder |
( |
oaBitOrder |
order |
) |
|
|
|
|
This function changes the bitOrder value associated with the oaBusNetDef. An exception is thrown if this busNetDef was implicitly created.
- Parameters:
-
| order | The new bitOrder value for this busNetDef |
- Exceptions:
-
|
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.
