oaModBusNetBit Class Reference

Inheritance diagram for oaModBusNetBit:

Public Methods
oaModBusNetDef *	getDef () const
oaUInt4	getBitIndex () const
void	getName (oaVectorBitName &name) const
void	setName (const oaScalarName &baseName, oaUInt4 bitIndex)
void	getName (oaName &name) const
void	getName (const oaNameSpace &ns, oaString &name) const
Static Public Methods
oaModBusNetBit *	create (oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex, oaSigType type=oacSignalSigType, oaBoolean isGlobal=false)
oaModBusNetBit *	create (oaModule *module, const oaVectorBitName &bitName, oaSigType type=oacSignalSigType, oaBoolean isGlobal=false)
oaModBusNetBit *	find (const oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex)
oaBoolean	isValidName (const oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex)

---

Detailed Description

The oaModBusNetBit class implements an oaModBitNet that represents a single bit of an oaModBusNet which is a busNet in the module domain. When a busNet is created, a corresponding set of busNetBits is automatically created. When the busNet is destroyed, the automatically created busNetBits are also destroyed. An implicitly created busNetBit cannot be used to connect to terminals or instTerms.

An oaModBusNetBit can be explicitly created and used in other operations like creating terminals or instTerms. An explicitly created busNetBit must be explicitly 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

oaModBusNetBit * oaModBusNetBit::create (  oaModule *    module, const oaVectorBitName &    bitName, oaSigType    sigType = oacSignalSigType, oaBoolean    isGlobal = false )  [static]

This function creates a busNetBit with the baseName and bitIndex as specified in the given bitName in the given module. Parameters: module  The module to create the net in bitName  The name specifying the baseName and bit index to give the net sigType  The signal type of the busNetBit isGlobal  Specifies if this is a global net Exceptions: oacBusNetNameMatchesAutoName  oacBusNetBaseNameMatchesScalarName  oacNetExists  oacImplicitModuleNetExists  oacImplicitBlockNetExists  oacInvalidHierNetName

oaModBusNetBit * oaModBusNetBit::create (  oaModule *    module, const oaScalarName &    baseName, oaUInt4    bitIndex, oaSigType    sigType = oacSignalSigType, oaBoolean    isGlobal = false )  [static]

This function creates a busNetBit with the specified baseName and bitIndex in the given module. Parameters: module  The module to create the net in baseName  The base name to give the net bitIndex  The bit index to give the net sigType  The signal type of the busNetBit isGlobal  Specifies if this is a global net Exceptions: oacBusNetNameMatchesAutoName  oacBusNetBaseNameMatchesScalarName  oacNetExists  oacImplicitModuleNetExists  oacImplicitBlockNetExists  oacInvalidHierNetName

oaModBusNetBit * oaModBusNetBit::find (  const oaModule *    module, const oaScalarName &    baseName, oaUInt4    bitIndex )  [static]

This function searches the specified module for a busNetBit with the specified baseName and bitIndex. The busNetBit is returned if found. Otherwise, NULL is returned. Parameters: module  The module to search baseName  The base name to find bitIndex  The bit index to find

oaUInt4 oaModBusNetBit::getBitIndex (    )  const

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

oaModBusNetDef * oaModBusNetBit::getDef (    )  const

This function returns the busNetDef associated with this busNetBit.

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 oaModBusNetBit::getName (  oaVectorBitName &    name )  const

This function returns the name of this modBusNetBit. Parameters: name  The name of the modBusNetBit to return

oaBoolean oaModBusNetBit::isValidName (  const oaModule *    module, const oaScalarName &    baseName, oaUInt4    bitIndex )  [static]

This function returns a boolean value indicating whether the specified name is valid for a new oaModBusNetBit in the specified module. Parameters: module  The module to search baseName  The base name of the bus bit bitIndex  The bit index of the bus bit

void oaModBusNetBit::setName (  const oaScalarName &    baseName, oaUInt4    bitIndex )

This function changes the name of this busNetBit to that implied by the given baseName and bitIndex. Parameters: baseName  The new base name for this net bitIndex  The new bit index for this net Exceptions: oacCannotSetNameOfImplicitNet  oacCannotSetNameOfNetInBundleNet  oacCannotSetNameOfNetInBusNet  oacBusNetBaseNameMatchesScalarName  oacNetExists

---

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

• oaModBusNetBit.h
• oaModBusNetBit.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.