oaBusTermBit Class Reference

Inheritance diagram for oaBusTermBit:

Public Methods
oaBusTermDef *	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
oaBusTermBit *	create (oaBitNet *net, const oaScalarName &baseName, oaUInt4 bitIndex, oaTermType termType=oacInputOutputTermType, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaBusTermBit *	create (oaBitNet *net, const oaVectorBitName &bitName, oaTermType termType=oacInputOutputTermType, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaBusTermBit *	find (const oaBlock *block, const oaScalarName &baseName, oaUInt4 bitIndex)
oaBoolean	isValidName (const oaBitNet *net, const oaScalarName &baseName, oaUInt4 bitIndex)

---

Detailed Description

The oaBusTermBit class implements an oaBitTerm that represents a single bit of an oaBusTerm. When a busTerm is created, a corresponding set of busTermBits is automatically created. When the busTerm is destroyed, the automatically created busTermBits are also destroyed. An implicitly created busTermBit cannot be used to connect to terminals or instTerms, nor can it be associated with shapes or routes.

An oaBusTermBit can be explicitly created and used in other operations like creating pins. An explicitly created busTermBit must be explicitly destroyed.

---

Member Function Documentation

oaBusTermBit * oaBusTermBit::create (  oaBitNet *    net, const oaVectorBitName &    bitName, oaTermType    termType = oacInputOutputTermType, oaBlockDomainVisibility    view = oacInheritFromTopBlock )  [static]

This function creates a busTermBit with the baseName and em bitIndex as specified in the given bitName on the given net. When creating a hidden term, the view argument must be set to oacExcludeFromModuleDomain. Parameters: net  The net to create the terminal on bitName  The name supplying the baseName and bit index to give the terminal termType  The type of terminal to create view  Specifies whether this net is visible in the module domain Exceptions: oacBusTermBaseNameMatchesScalarName  oacNetTermWidthMismatch  oacTermExists  oacTermMemberExists  oacCannotCreateTermWithImplicitNet  oacOverridingTermAlreadyExist  oacCannotBlockOverrideNetSignalType  oacPhysOnlyTermNetMustBeInSameOcc

oaBusTermBit * oaBusTermBit::create (  oaBitNet *    net, const oaScalarName &    baseName, oaUInt4    bitIndex, oaTermType    termType = oacInputOutputTermType, oaBlockDomainVisibility    view = oacInheritFromTopBlock )  [static]

This function creates a busTermBit with the specified baseName and bitIndex on the given net. When creating a hidden term, the view argument must be set to oacExcludeFromModuleDomain. Parameters: net  The net to create the terminal on baseName  The base name to give the terminal bitIndex  The bit index to give the terminal termType  The type of terminal to create view  Specifies whether this net is visible in the module domain Exceptions: oacBusTermBaseNameMatchesScalarName  oacTermExists  oacTermMemberExists  oacCannotCreateTermWithImplicitNet  oacOverridingTermAlreadyExist  oacCannotBlockOverrideNetSignalType  oacPhysOnlyTermNetMustBeInSameOcc

oaBusTermBit * oaBusTermBit::find (  const oaBlock *    block, const oaScalarName &    baseName, oaUInt4    bitIndex )  [static]

This function searches the specified block for a busTermBit with the specified baseName and bitIndex. The busTermBit is returned if found. Otherwise, NULL is returned. If the specified term is hidden, that is the term returned. Parameters: block  The block to search for the busTermBit baseName  The base name for the busTermBit bitIndex  The bit index for the busTermBit Returns: A pointer to an oaBusTermBit

oaUInt4 oaBusTermBit::getBitIndex (    )  const

This function returns the index for this busTermBit, with the respect of the corresponding busTermDef.

oaBusTermDef * oaBusTermBit::getDef (    )  const

This function returns the busTermDef associated with this terminal.

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

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

void oaTerm::getName (  oaName &    name )  const

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

void oaBusTermBit::getName (  oaVectorBitName &    name )  const

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

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

This function returns a boolean value indicating whether the specified name is valid for a new oaBusTermBit on the specified net. This function also returns true if the name corresponds to a busTermBit that was hidden but not overridden. Parameters: net  The net to search baseName  The base name of the bus bit bitIndex  The bit index of the bus bit

void oaBusTermBit::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  oacCannotSetNameOfTermInBundleTerm  oacBusTermBaseNameMatchesScalarName  oacTermMemberExists  oacTermExists

---

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

• oaBusTermBit.h
• oaBusTermBit.dox

Return to top of page

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