oaOccBundleNet Class Reference

Inheritance diagram for oaOccBundleNet:

oaOccNet oaOccObject oaDesignObject oaObject


Public Methods

oaUInt4 getNumMembers () const
oaUInt4 getRepeat (oaUInt4 index) const
oaOccNet * getMember (oaUInt4 index) const
oaBundleNet * getNet () const
oaModBundleNet * getModNet () const
void getName (oaBundleName &name) const
void getPathName (oaBundleName &pathName) const
oaCollection< oaOccNet, oaOccBundleNet > getMembers () 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

oaOccBundleNet * find (const oaOccurrence *occurrence, const oaBundleName &name)

Detailed Description

This class implements a multi-bit net composed of one or more scalar nets, bus nets, or a combination of both. When an oaOccBundleNet is created, all member nets specified as part of the bundle name expression are added to it. The constituent scalar nets and bus nets are automatically created as implicit nets if they do not already exist.

Member Function Documentation

oaOccBundleNet * oaOccBundleNet::find (  const oaOccurrence *    occurrence,
const oaBundleName &    name
)  [static]
 

This function searches the specified occurrence looking for a bundleNet with the specified name. If the members of name are hierarchical, this function will descend into lower levels of occurrence hierarchy, expanding the hierarchy and binding the master designs as needed. If any of the members of name are hierarchical, every member must have the same hierarchical path or an exception is thrown. The bundleNet is returned if found, otherwise NULL is returned.

Parameters:
occurrence The occurrence in which to search
name The name of the bundle to find
Returns:
A pointer to the oaOccBundleNet

oaModNet * oaOccBundleNet::getMember (  oaUInt4    memIndex )  const
 

This function returns the specified member of this net at the specified bundle member index.

Parameters:
memIndex The bundle member index of the net to be returned.
Returns:
A pointer to an oaModNet
Exceptions:
oacInvalidBundleNetMemberIndex 

oaCollection oaOccBundleNet::getMembers (    )  const
 

This function returns a collection of the member nets in this oaOccBundleNet.

oaModBundleNet* oaOccBundleNet::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 oaOccBundleNet::getName (  oaBundleName &    name )  const
 

This function returns the name of this occBundleNet.

Parameters:
name The name of the occBundleNet to return

oaBundleNet* oaOccBundleNet::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.

oaUInt4 oaOccBundleNet::getNumMembers (    )  const
 

This function returns the number of members in this oaOccBundleNet. Each member net in an oaOccBundleNet can repeat.

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 oaOccBundleNet::getPathName (  oaBundleName &    pathName )  const
 

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

Parameters:
pathName The pathName of the occBundleNet to return

oaUInt4 oaOccBundleNet::getRepeat (  oaUInt4    memIndex )  const
 

This function returns the repeat count for the specified member of this oaOccBundleNet.

For example, for oaOccBundleNet a,b,c, the repeat count for each member is one. An oaOccBundleNet x,100*y[0:1] contains two members, and the repeat count for the second member is 100. The number of bits for the net is 201.

Parameters:
memIndex The member number for which to return the repeat count
Returns:
An unsigned value indicating the repeat count for the specified member of the oaOccBundleNet
Exceptions:
oacInvalidBundleNetMemberIndex 

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.