oaOccBusNet Class Reference

Inheritance diagram for oaOccBusNet:

oaOccNet oaOccObject oaDesignObject oaObject


Public Methods

oaOccBusNetDef * getDef () const
oaUInt4 getStart () const
oaUInt4 getStop () const
oaUInt4 getStep () const
oaBusNet * getNet () const
oaModBusNet * getModNet () const
void getName (oaVectorName &name) const
void getPathName (oaVectorName &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

oaOccBusNet * find (const oaOccurrence *occurrence, const oaScalarName &baseName, oaUInt4 start, oaUInt4 stop, oaUInt4 step)

Detailed Description

The oaOccBusNet class implements a net that can represent one or more bits that are associated with a common base name and vector range specification. A busNet has a corresponding busNetDef that manages all busNets that share the same base name.

Member Function Documentation

oaOccBusNet * oaOccBusNet::find (  const oaOccurrence *    occurrence,
const oaScalarName &    baseName,
oaUInt4    start,
oaUInt4    stop,
oaUInt4    step
)  [static]
 

This function searches the specified occurrence for a busNet with the specified baseName and start, stop, step indices. 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 busNet is returned if found, otherwise NULL is returned.

Parameters:
occurrence The occurrence in which to search
baseName The base name for the net
start The starting index of the net
stop The stopping index of the net
step The index increment value from start to step; step should be greater than zero
Returns:
A pointer to the oaOccBusNet

oaOccBusNetDef * oaOccBusNet::getDef (    )  const
 

This function returns the busNetDef for this busNet.

Returns:
A pointer to an oaOccBusNetDef

oaModBusNet* oaOccBusNet::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 oaOccBusNet::getName (  oaVectorName &    name )  const
 

oaOccBusNet::getName()

This function returns the name of this occBusNet.

Parameters:
name The name of the occBusNet to return

oaBusNet* oaOccBusNet::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 oaOccBusNet::getPathName (  oaVectorName &    pathName )  const
 

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

Parameters:
pathName The pathName of the occBusNet to return

oaUInt4 oaOccBusNet::getStart (    )  const
 

This function returns the starting index for this busNet.

Returns:
The starting index of this busNet

oaUInt4 oaOccBusNet::getStep (    )  const
 

This function returns the step value for this busNet.

Returns:
The step value for this busNet

oaUInt4 oaOccBusNet::getStop (    )  const
 

This function returns the ending index for this busNet.

Returns:
The ending index for this busNet

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.