oaBundleTerm Class Reference

Inheritance diagram for oaBundleTerm:

oaTerm oaBlockObject oaDesignObject oaObject


Public Methods

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

Static Public Methods

oaBundleTerm * create (oaNet *net, const oaBundleName &name, oaTermType termType=oacInputOutputTermType, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaBundleTerm * find (const oaBlock *block, const oaBundleName &name)
oaBoolean isValidName (oaBlock *block, oaNet *net, const oaBundleName &name)

Detailed Description

The oaBundleTerm class implements a multi-bit terminal for a block composed of one or more scalarTerms, one or more busTerms, or a combination of scalarTerms and busTerms. When a bundleTerm is created, the constituent scalarTerms and busNetBits are automatically created if they do not already exist. Bundle terms are associated with bundle nets (oaBundleNet) to represent connectivity. The number of bits implied by the name of the bundle term and bundle net must match to be meaningful.

Member Function Documentation

oaBundleTerm * oaBundleTerm::create (  oaNet *    net,
const oaBundleName &    name,
oaTermType    termType = oacInputOutputTermType,
oaBlockDomainVisibility    view = oacInheritFromTopBlock
)  [static]
 

This function creates an oaBundleTerm object on the specified net with the specified attributes. The given name specifies the members of the bundleTerm. These member terminals are automatically created if they do not already exist. The number of bits implied by the name must match the number of bits in the given net.

Parameters:
net A pointer to the net to associate with the terminal; the bits of the net are associated with the constituent bits of the automatically created member terminals
name The name of the terminal
termType The type of terminal to create
view Specifies whether this net is visible in the module domain
Returns:
A pointer to an oaBundleTerm
Exceptions:
oacNetTermWidthMismatch 
oacTermExists 
oacCannotCreateTermWithImplicitNet 
oacTermNetMustBeInUniqueOccHier 
oacPhysOnlyTermNetMustBeInSameOcc 
oacTermNetMismatchInRepeatedMembers 

oaBundleTerm * oaBundleTerm::find (  const oaBlock *    block,
const oaBundleName &    name
)  [static]
 

This function searches the specified block for a bundleTerm with the given name. The bundleTerm is returned if it exists. Otherwise, NULL is returned. If the specified term is hidden, that is the term returned.

Parameters:
block The block to search
name The name of the terminal
Returns:
A pointer to an oaBundleTerm if found; otherwise, NULL is returned

oaTerm * oaBundleTerm::getMember (  oaUInt4    memIndex )  const
 

This function returns the memIndex member of this bundleTerm.

Parameters:
memIndex The bundle member index of the member term to get
Returns:
A pointer to an oaTerm
Exceptions:
oacInvalidBundleTermMemberIndex 

oaCollection< oaTerm, oaBundleTerm > oaBundleTerm::getMembers (    )  const
 

This function returns a collection of member terms in this bundleTerm.

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

This function returns the name of this oaBundleTerm.

Parameters:
name The name of the oaBundleTerm to return

oaUInt4 oaBundleTerm::getNumMembers (    )  const
 

This function returns the number of members in this bundleTerm.

Returns:
The number of member terminals in this bundleTerm

oaBoolean oaBundleTerm::isValidName (  oaBlock *    block,
oaNet *    net,
const oaBundleName &    name
)  [static]
 

This function returns a boolean value indicating whether the specified name is valid for a new oaBundleTerm object associated with the specified net. This function returns true if the specified bundleTerm is hidden but not overridden.

Parameters:
block The block in which to create the new bundle terminal
net The net with which to associate the new bundle terminal
name The name of the new bundle terminal

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.