oaOccBitNet Class Reference

Inheritance diagram for oaOccBitNet:

oaOccNet oaOccObject oaDesignObject oaObject oaOccBusNetBit oaOccScalarNet


Public Methods

oaBoolean isPreferredEquivalent () const
oaOccNetConnectDefgetConnectDef () const
oaOccBitNet * getPreferredEquivalent () const
void getParasiticConfidence (oaUInt4 &minValue, oaUInt4 &maxValue) const
void setParasiticConfidence (oaUInt4 value)
void setParasiticConfidence (oaUInt4 minValue, oaUInt4 maxValue)
oaCollection< oaOccBitNet, oaOccBitNet > getEquivalentNets () const
oaCollection< oaOccBitNet, oaOccBitNet > getEquivalentNets (oaUInt4 filterFlags) const

Detailed Description

The oaOccBitNet class is the base class for single-bit nets that are part of the design's logical 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, oaModNetConnectDef, with a bitNet.


Member Function Documentation

oaOccNetConnectDef * oaOccBitNet::getConnectDef   const
 

This function returns the connection definition associated with this net if there is one. NULL is returned if the net is not associated with a connection definition.

oaCollection oaOccBitNet::getEquivalentNets oaUInt4    filterFlags const
 

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:
oacInvalidEquivalentNetIterFlags 

oaCollection oaOccBitNet::getEquivalentNets   const
 

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 ).

void oaOccBitNet::getParasiticConfidence oaUInt4 &    minValue,
oaUInt4 &    maxValue
const
 

This function returns the min and max parasitic confidence values. These are defined to be between 0 and 100.

Parameters:
minValue returned min parasitic confidence value
maxValue returned max parasitic confidence value

oaOccBitNet * oaOccBitNet::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.

oaBoolean oaOccBitNet::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 oaOccBitNet::setParasiticConfidence oaUInt4    minValue,
oaUInt4    maxValue
 

This function sets the specified min (minValue) and max (maxValue) parasitic confidence values for this net. Parasitic confidence values must be between 0 and 100.

Parameters:
minValue the min parasitic confidence value (from 0 to 100) to set on this net
maxValue the max parasitic confidence value (from 0 to 100) to set on this net
Exceptions:
oacInvalidParasiticConfidenceValue 
oacCannotSetParasiticConfImplicitNet 

void oaOccBitNet::setParasiticConfidence oaUInt4    value
 

This function sets both the min and max parasitic confidence value for this net to the specified value. The parasitic confidence value must be between 0 and 100.

Parameters:
value the min and max parasitic confidence value (from 0 to 100) to set on this net
Exceptions:
oacInvalidParasiticConfidenceValue 
oacCannotSetParasiticConfImplicitNet 


The documentation for this class was generated from the following files:

Return to top of page