oaOccBusNetBit Class Reference

Inheritance diagram for oaOccBusNetBit:

oaOccBitNet oaOccNet oaOccObject oaDesignObject oaObject


Public Methods

oaBusNetBit * getNet () const
oaModBusNetBit * getModNet () const
oaOccBusNetDef * getDef () const
oaUInt4 getBitIndex () const
void getName (oaVectorBitName &name) const
void getPathName (oaVectorBitName &pathName) const
void getName (oaName &name) const
void getName (const oaNameSpace &ns, oaString &name) const
void getPathName (oaName &pathName) const
void getPathName (const oaNameSpace &ns, oaString &pathName) const

Static Public Methods

oaOccBusNetBit * find (const oaOccurrence *occurrence, const oaScalarName &baseName, oaUInt4 bitIndex)

Detailed Description

The oaOccBusNetBit class implements an oaOccBitNet that represents a single bit of an oaOccBusNet which is a busNet in the occurrence domain. When a busNet is created in either the block or module domain, a corresponding set of busNetBits is automatically created and corresponding occurrence busNetBits are also created. When the busNet is destroyed, the automatically created busNetBits are also destroyed.

oaModBusNetBit, oaOccBusNetmBit, and oaBusNetBit each represent a bit of a busNet on a different kind of master, where in each case the master represents a level of hierarchy in the design.

For oaModBusNetBit, the master is a module, and each module in a design will have a set of zero or more oaModBusNetBits. For oaOccBusNetBit, the master is an oaOccurrence.

For oaBusNet, the master is an oaBlock, and the top block for the design will have a set of zero or more modBusNetBits. Typically, many of the oaBusNetBits on the top oaBlock have a corresponding oaModBusNetBit on the top oaModule. All of the oaBusNetBits on the top oaBlock have a corresponding oaOccBusNetBit on the top oaOccurrence.

When oaBusNetBit objects are created in the block domain, the corresponding oaModBusNetBit objects are automatically created on the top oaModule.

Member Function Documentation

oaOccBusNetBit * oaOccBusNetBit::find (  const oaOccurrence *    occurrence,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

This function searches the specified occurrence looking for a busNetBit with the specified baseName and bitIndex. 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 busNetBit is returned if found, otherwise NULL is returned.

Parameters:
occurrence The occurrence in which to search
baseName The base name of the busNetBit to find
bitIndex The bit index of the busNetBit to find
Returns:
A pointer to the oaOccBusNetBit

oaUInt4 oaOccBusNetBit::getBitIndex (    )  const
 

This function returns the index for this busNetBit. Returns can include non-consecutive numbers.

oaOccBusNetDef * oaOccBusNetBit::getDef (    )  const
 

This function returns the busNetDef associated with this busNetBit.

oaModBusNetBit* oaOccBusNetBit::getModNet (    )  const
 

This function returns a pointer to the corresponding net in the module domain. NULL will be returned if this net is an occurrence of a physical-only net.

Returns:
A pointer to an oaModNet

Reimplemented from oaOccNet.

void oaOccNet::getName (  const oaNameSpace &    ns,
oaString &    name
)  const
 

This function returns the local name of this net in the specified nameSpace in the specified name string. The name is relative to the parent occurrence of this net.

Parameters:
ns The nameSpace used to map the name
name The returned net name

void oaOccNet::getName (  oaName &    name )  const
 

This function returns the local name of this net within its parent occurrence.

Parameters:
name The returned net name

void oaOccBusNetBit::getName (  oaVectorBitName &    name )  const
 

This function returns the name of this occBusNetBit.

Parameters:
name The name of the occBusNetBit to return

oaBusNetBit* oaOccBusNetBit::getNet (    )  const
 

This function returns a pointer to the corresponding net in the block domain. NULL is returned if this occurrence net is not visible to the block domain.

Returns:
A pointer to an oaNet

Reimplemented from oaOccNet.

void oaOccNet::getPathName (  const oaNameSpace &    ns,
oaString &    pathName
)  const
 

This function returns the full path name of this net in the specified nameSpace in the specified pathName string. The pathName is relative to the top occurrence in the occurrence hierarchy containing this net.

Parameters:
ns The nameSpace used to map the name
pathName The returned path name

void oaOccNet::getPathName (  oaName &    pathName )  const
 

This function returns the full path name of this net, relative to the top occurrence in the occurrence hierarchy containing this net.

Parameters:
pathName The returned path name

void oaOccBusNetBit::getPathName (  oaVectorBitName &    pathName )  const
 

This function returns the full path name of this busNetBit, relative to the top occurrence in the occurrence hierarchy containing this busNetBit.

Parameters:
pathName The pathName of the occBusNetBit to return

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.