oaModBundleNet Class Reference

Inheritance diagram for oaModBundleNet:

oaModNet oaModObject oaDesignObject oaObject


Public Methods

oaUInt4 getNumMembers () const
oaUInt4 getRepeat (oaUInt4 index) const
oaModNet * getMember (oaUInt4 index) const
void getName (oaBundleName &name) const
oaCollection< oaModNet, oaModBundleNet > getMembers () const
void getName (oaName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaModBundleNet * create (oaModule *module, const oaBundleName &name, oaSigType type=oacSignalSigType, oaBoolean isGlobal=false)
oaModBundleNet * find (const oaModule *module, const oaBundleName &name)
oaBoolean isValidName (const oaModule *module, 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 oaModBundleNet 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

oaModBundleNet * oaModBundleNet::create (  oaModule *    module,
const oaBundleName &    name,
oaSigType    sigType = oacSignalSigType,
oaBoolean    isGlobal = false
)  [static]
 

This function creates an oaModBundleNet object in the specified module with the specified attributes. The name specifies the members of the oaBundleNet object and these member nets are automatically created if they do not already exist in the specified block. An exception is thrown if an oaModBundleNet object with the given name already exists.

Parameters:
module The module in which to create the oaModBundleNet
name The name of this oaModBundleNet. The members of the bundleNet are derived from the name.
sigType The signal type to associate with this net
isGlobal Specifies if this is a global net
Returns:
A pointer to an oaModBundleNet
Exceptions:
oacNetExists 

oaModBundleNet * oaModBundleNet::find (  const oaModule *    module,
const oaBundleName &    name
)  [static]
 

This function searches the specified module for an oaModBundleNet with the specified name.

Parameters:
module The module to search
name The name of the oaModBundleNet to find
Returns:
A pointer to an oaModBundleNet; NULL is returned if found

oaModNet * oaModBundleNet::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< oaModNet, oaModBundleNet > oaModBundleNet::getMembers (    )  const
 

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

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

This function returns the name of this net in the specified nameSpace in the specified name string.

void oaModNet::getName (  oaName &    name )  const
 

This function returns the name of this net in the name argument.

void oaModBundleNet::getName (  oaBundleName &    name )  const
 

This function returns the name of this modBundleNet.

Parameters:
name The name of the modBundleNet to return

oaUInt4 oaModBundleNet::getNumMembers (    )  const
 

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

oaUInt4 oaModBundleNet::getRepeat (  oaUInt4    memIndex )  const
 

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

For example, for oaModBundleNet a,b,c, the repeat count for each member is one. An oaModBundleNet 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 oaModBundleNet
Exceptions:
oacInvalidBundleNetMemberIndex 

oaBoolean oaModBundleNet::isValidName (  const oaModule *    module,
const oaBundleName &    name
)  [static]
 

This function returns a boolean value indicating whether the specified name is valid for a new oaModBundleNet in the specified module.

Parameters:
module The module in which to check the oaModBundleNet name
name The name of the new oaModBundleNet that might be created

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.