oaModBitNet Class Reference

Inheritance diagram for oaModBitNet:

oaModNet oaModObject oaDesignObject oaObject oaModBusNetBit oaModScalarNet


Public Methods

oaBoolean isPreferredEquivalent () const
oaModNetConnectDefgetConnectDef () const
oaModBitNet * getPreferredEquivalent () const
void setPreferredEquivalent ()
void makeEquivalent (oaModBitNet *equivNet)
void breakEquivalence ()
oaBoolean hasImplicitEquivalence () const
oaCollection< oaModBitNet, oaModBitNet > getEquivalentNets () const
oaCollection< oaModBitNet, oaModBitNet > getEquivalentNets (oaUInt4 filterFlags) const

Detailed Description

The oaModBitNet 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

void oaModBitNet::breakEquivalence  
 

This function breaks the equivalence between this net with all other nets it was equivalent to.

Exceptions:
oacNetHasNoEquivNet 
oacCannotModifyImplicitNetEquivalence 

oaModNetConnectDef * oaModBitNet::getConnectDef   const
 

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

oaCollection oaModBitNet::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 oaModBitNet::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 ).

oaModBitNet * oaModBitNet::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 oaModBitNet::hasImplicitEquivalence   const
 

This function returns true if the equivalence cannot be modified, for example by calling breakEquivalence().

oaBoolean oaModBitNet::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 oaModBitNet::makeEquivalent oaModBitNet *    equivNet
 

This function will set this net and the specified net equivalent. Exceptions are thrown if the given net is NULL, if this and the given net are in different designs, or if either net is multi-bit.

Parameters:
equivNet The net to be set as equivalent to this net.
Exceptions:
oacInvalidNet 
oacNetEquivNetNotInSameDesign 

void oaModBitNet::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.


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

Return to top of page