oaOccBusTerm Class Reference

Inheritance diagram for oaOccBusTerm:

oaOccTerm oaOccObject oaDesignObject oaObject


Public Methods

oaOccBusTermDef * getDef () const
oaUInt4 getStart () const
oaUInt4 getStop () const
oaUInt4 getStep () const
oaBusTerm * getTerm () const
oaModBusTerm * getModTerm () const
void getName (oaVectorName &name) const
void getName (oaName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaOccBusTerm * find (const oaOccurrence *occurrence, const oaScalarName &name, oaUInt4 start, oaUInt4 stop, oaUInt4 step)

Detailed Description

The oaOccBusTerm class implements a terminal in the occurrence domain that represents one or more bits that are associated by a common baseName and vector-range specification. An oaOccBusTerm object has a corresponding oaOccBusTermDef object that manages all oaOccBusTerm objects that share the same baseName.

oaModBusTerm, oaOccBusTerm, and oaBusTerm each represent bus terminals on a different kind of master, where in each case the master represents a level of hierarchy in the design.

For oaOccBusTerm, the master is an oaOccurrence, which corresponds to a unique usage of a module or a block in a design. Each oaOccurrence in a design will have a set of zero or more occBusTerms.

For oaModBusTerm, the master is an oaModule. For oaBusTerm, the master is an oaBlock, and the top block for the design will have a set of zero or more modBusTerms. Typically, many of the oaBusTerms on the top oaBlock have a corresponding oaModBusTerm on the top oaModule. The top oaOccurrence will have a corresponding oaOccBusTerm for each busTerm in the union of the terminals between the top oaModule and the top oaBlock.

When oaBusTerm objects are created in the block domain, the corresponding oaOccBusTerm objects are automatically created on the top oaOccurrence.

Member Function Documentation

oaOccBusTerm * oaOccBusTerm::find (  const oaOccurrence *    occ,
const oaScalarName &    baseName,
oaUInt4    start,
oaUInt4    stop,
oaUInt4    step
)  [static]
 

This function searches the specified occ for an oaOccBusTerm object with the specified baseName and start, stop, and step indices. The oaOccBusTerm object is returned if found. Otherwise, NULL is returned.

Parameters:
occ The occurrence to search for the oaOccBusTerm
baseName The baseName for the oaOccBusTerm
start The starting index of the oaOccBusTerm
stop The stopping index of the oaOccBusTerm
step The step value of the oaOccBusTerm
Returns:
A pointer to an oaOccBusTerm

oaOccBusTermDef * oaOccBusTerm::getDef (    )  const
 

This function returns the oaOccBusTermDef for this oaOccBusTerm object.

Returns:
A pointer to an oaOccBusTermDef

oaModBusTerm * oaOccBusTerm::getModTerm (    )  const
 

This function returns the corresponding terminal in the module domain, or NULL if the terminal is not visible in the module domain.

Reimplemented from oaOccTerm.

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

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

void oaOccTerm::getName (  oaName &    name )  const
 

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

void oaOccBusTerm::getName (  oaVectorName &    name )  const
 

This function returns the name of this occBusTerm.

Parameters:
name The name of the occBusTerm to return

oaUInt4 oaOccBusTerm::getStart (    )  const
 

This function returns the starting index for this oaOccBusTerm object.

Returns:
The starting index for this oaOccBusTerm

oaUInt4 oaOccBusTerm::getStep (    )  const
 

This function returns the stepping index for this oaOccBusTerm object.

Returns:
The step value for this oaOccBusTerm

oaUInt4 oaOccBusTerm::getStop (    )  const
 

This function returns the ending index for this oaOccBusTerm object.

Returns:
The ending index for this oaOccBusTerm

oaBusTerm * oaOccBusTerm::getTerm (    )  const
 

This function returns the corresponding terminal in the block domain, or NULL if the terminal is not visible in the block domain.

Reimplemented from oaOccTerm.

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.