oaModBusTermBit Class Reference

Inheritance diagram for oaModBusTermBit:

oaModBitTerm oaModTerm oaModObject oaDesignObject oaObject


Public Methods

oaModBusTermDef * 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

oaModBusTermBit * create (oaModBitNet *modNet, const oaScalarName &baseName, oaUInt4 bitIndex, oaTermType type=oacInputOutputTermType)
oaModBusTermBit * create (oaModBitNet *modNet, const oaVectorBitName &bitName, oaTermType type=oacInputOutputTermType)
oaModBusTermBit * find (const oaModule *module, const oaScalarName &baseName, oaUInt4 bitIndex)
oaBoolean isValidName (const oaModBitNet *net, const oaScalarName &baseName, oaUInt4 bitIndex)

Detailed Description

The oaModBusTermBit class implements an oaModBitNet that represents a single bit of an oaModBusTerm, a busTerm in the module domain. When an oaModBusTerm is created, a corresponding set of oaModBusTermBit objects is automatically created. When the busTerm is destroyed, the automatically created busTermBits are also destroyed.

An oaModBusTermBit can be explicitly created. An explicitly created busTermBit must be explicitly destroyed.

oaModBusTermBit, oaOccBusTermBit, and oaBusTermBit each represent a bit of a busTerminal on a different kind of master, where in each case the master represents a level of hierarchy in the design.

For oaModBusTermBit, the master is a module, and each module in a design will have a set of zero or more oaModBusTermBits. For oaOccBusTermBit, the master is an oaOccurrence.

For oaBusTerm, the master is an oaBlock, and the top block for the design will have a set of zero or more modBusTermBits. Typically, many of the oaBusTermBits on the top oaBlock have a corresponding oaModBusTermBit on the top oaModule. All of the oaBusTermBits on the top oaBlock have a corresponding oaOccBusTermBit on the top oaOccurrence.

When oaBusTermBit objects are created in the block domain, the corresponding oaModBusTermBit objects are automatically created on the top oaModule.

Member Function Documentation

oaModBusTermBit * oaModBusTermBit::create (  oaModBitNet *    modNet,
const oaVectorBitName &    bitName,
oaTermType    type = oacInputOutputTermType
)  [static]
 

This function creates a busTermBit with the baseName as specified by bitName on the given modNet.

Parameters:
modNet The module net to create the terminal on
bitName The name specifying the baseName and bitIndex to give the terminal
type The terminal type to give the terminal
Exceptions:
oacBusTermBaseNameMatchesScalarName 
oacTermExists 
oacTermMemberExists 
oacCannotCreateTermWithImplicitNet 

oaModBusTermBit * oaModBusTermBit::create (  oaModBitNet *    modNet,
const oaScalarName &    baseName,
oaUInt4    bitIndex,
oaTermType    type = oacInputOutputTermType
)  [static]
 

This function creates a busTermBit with the specified baseName and bitIndex in the given module net.

Parameters:
modNet The module net to create the terminal on
baseName The base name to give the terminal
bitIndex The bit index to give the terminal
type The terminal type to give the terminal
Exceptions:
oacBusTermBaseNameMatchesScalarName 
oacTermExists 
oacTermMemberExists 
oacCannotCreateTermWithImplicitNet 

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

This function searches the specified module for a busTermBit with the specified baseName and bitIndex. The busTermBit is returned if found. Otherwise, NULL is returned. If the specified busTermBit is hidden, that is the term returned. If the reflected term in the block domain is hidden and overridden, the busTermBit corresponding to the hidden term is always returned.

Parameters:
module The module to search for the busTermBit
baseName The base name for the busTermBit
bitIndex The bit index for the busTermBit
Returns:
A pointer to an oaModBusTermBit

oaUInt4 oaModBusTermBit::getBitIndex (    )  const
 

This function returns the index for this busTermBit.

oaModBusTermDef * oaModBusTermBit::getDef (    )  const
 

This function returns the modBusTermDef associated with this terminal.

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

This function fills in name with the name of this terminal mapped to the specified nameSpace.

void oaModTerm::getName (  oaName &    name )  const
 

This function fills out name with the name of this terminal.

void oaModBusTermBit::getName (  oaVectorBitName &    name )  const
 

This function returns the name of this modBusTermBit.

Parameters:
name The name of the modBusTermBit to return

oaBoolean oaModBusTermBit::isValidName (  const oaModBitNet *    net,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

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

Parameters:
net The module net to search
baseName The base name of the bus bit
bitIndex The bit index of the bus bit

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

This function changes the name of this busTermBit 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:
oacCannotSetNameOfImplicitTerm 
oacCannotSetNameOfOverriddenTerm 
oacBusTermBaseNameMatchesScalarName 
oacTermExists 

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.