oaBitNet Class Reference
Inheritance diagram for oaBitNet:
Detailed Description
The oaBitNet class is the base class for single-bit nets that are part of the design's physical description.
You can have two or more bitNets that are equivalent. Equivalent bitNets are traversed separately or logically as the same net.
You can create associate a connection definition, oaNetConnectDef, with a bitNet.
Member Function Documentation
| void oaBitNet::breakEquivalence |
( |
|
) |
|
|
|
|
This function breaks the net equivalence between this net and all other nets that are equivalent.
- Exceptions:
-
|
|
|
This function returns the connection definition associated with this net if there is one. Otherwise, NULL is returned. |
|
|
This function returns the setting for this net that determines if optimization is allowed to change its connectivity. |
|
|
This function returns a collection of nets equivalent to this net.
This function gets the collection of all equivalent nets not including the net used to get the collection. The returned collection will be empty if there are no equivalent nets assigned to this net.
- Parameters:
-
| filterFlags | Specifies what the collection contains. The bits flags are defined as follows:
- oacEquivalentNetIterExplicit: the collection will only contain equivalences that that were explicitly created by the application
- oacEquivalentNetIterImplicit: the collection will only contain equivalences that were created by OA as a result of overlapping or repeated bits in terms or instTerms
- oacEquivalentNetIterAll: the collection will contain all equivalences both implicit and explicit
|
- Exceptions:
-
|
|
|
This function returns a collection of nets equivalent to this net.
This function gets the collection of all equivalent nets not including the net used to get the collection. The returned collection will be empty if there are no equivalent nets assigned to this net. Note that this function returns the same collection as getEquivalentNets ( oacEquivalentNetIterAll ). |
| oaBitNet * oaBitNet::getOriginal |
( |
|
) |
const |
|
|
|
This function returns the original net for this bit net. |
| void oaBitNet::getParasiticConfidence |
( |
oaUInt4 & |
minValue, |
|
|
oaUInt4 & |
maxValue |
|
) |
const |
|
|
|
This function returns the minimum and maximum parasitic confidence values. These values are can be between 0 and 100.
- Parameters:
-
| minValue | A reference to an integer to be populated with the minimum value |
| maxValue | A reference to an integer to be populated with the maximum value |
|
| oaBitNet * oaBitNet::getPreferredEquivalent |
( |
|
) |
const |
|
|
|
This function returns the preferred equivalent net associated with this net. If this net does not have any equivalents, the net itself is returned since it is considered the preferred equivalent of itself. |
|
|
This function returns the routePattern value of this net. |
| oaBitNet * oaBitNet::getShieldNet1 |
( |
|
) |
const |
|
|
|
Nets can have up to 2 other nets that will be routed in parallel with it to shield it from signal noise. Shield nets are usually power or ground nets. This function returns the first shield net for this net if it exists.
When an oaRoute is created on that shield net that will provide this shielding then the route will point to this net as its shielded net. See oaRoute::getShielding1 for that relationship. |
| oaBitNet * oaBitNet::getShieldNet2 |
( |
|
) |
const |
|
|
|
This function returns the second shield net for this net if it exists. |
| oaFloat oaBitNet::getVoltage |
( |
|
) |
const |
|
|
|
This function returns the voltage for this net. |
| oaBoolean oaBitNet::hasImplicitEquivalence |
( |
|
) |
const |
|
|
|
This function returns true if this net is implicitly equivalent to another net due to overlapping or repeated bits in terms or instTerms.
This type of equivalence cannot be modified by calling breakEquivalence. |
|
|
This function returns true if this net is an original net. |
| oaBoolean oaBitNet::isPreferredEquivalent |
( |
|
) |
const |
|
|
|
This function returns a boolean value that indicates if this net is the preferred equivalent net in a set of equivalent nets. true is also returned if the net does not have any equivalents. |
| void oaBitNet::makeEquivalent |
( |
oaBitNet * |
equivNet |
) |
|
|
|
|
This function sets this net and the specified net as equivalent.
- Parameters:
-
| equivNet | The net to establish equivalency with. |
- Exceptions:
-
|
|
|
This function sets the connectivity status for this net which determines if optimization is allowed to change its connectivity.
- Parameters:
-
- Exceptions:
-
|
| void oaBitNet::setOriginal |
( |
oaBitNet * |
original |
) |
|
|
|
|
This function sets the original net for this bit net. This net becomes a derived net of the original net. Setting a net's original net to itself does nothing. Setting the original net to NULL will unset the original net.
- Parameters:
-
| original | The net that this net will be considered derived from |
- Exceptions:
-
|
| void oaBitNet::setParasiticConfidence |
( |
oaUInt4 |
minValue, |
|
|
oaUInt4 |
maxValue |
|
) |
|
|
|
|
This function sets the minimum and maximum parasitic confidence values for this net. These values must be between 0 and 100.
- Parameters:
-
| minValue | A reference to an integer to be populated with the minimum value |
| maxValue | A reference to an integer to be populated with the maximum value |
- Exceptions:
-
|
| void oaBitNet::setParasiticConfidence |
( |
oaUInt4 |
value |
) |
|
|
|
|
This function sets the minimum and maximum parasitic confidence values for this net. Since only one value is specified, the minimum and maximum values are the same. The parasitic confidence values must be between 0 and 100.
- Parameters:
-
| value | The value to the confidence values to for this net. |
- Exceptions:
-
|
| void oaBitNet::setPreferredEquivalent |
( |
|
) |
|
|
|
|
This function sets this net to the preferred net of a set of equivalent nets. If this net does not have any equivalents, this function does nothing. |
|
|
This function sets the routePattern for this net to the specified value.
- Parameters:
-
- Exceptions:
-
|
| void oaBitNet::setShieldNet1 |
( |
oaBitNet * |
shieldNet |
) |
|
|
|
|
This function sets shield net 1 for this net to the specified net. Setting the shield net to NULL unsets the shield net. A net can have zero, one, or two shield nets.
- Parameters:
-
| shieldNet | The new shield one net value for this net. |
- Exceptions:
-
|
| void oaBitNet::setShieldNet2 |
( |
oaBitNet * |
shieldNet |
) |
|
|
|
|
This function sets shield net 2 for this net to the specified net. Setting the shield net to NULL unsets the shield net. A net can have zero, one, or two shield nets.
- Parameters:
-
| shieldNet | The new shield two net value for this net. |
- Exceptions:
-
|
| void oaBitNet::setVoltage |
( |
oaFloat |
voltage |
) |
|
|
|
|
This function sets the voltage for this net to the specified value.
- Parameters:
-
| voltage | The new voltage value for this net. |
- Exceptions:
-
|
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.
