oaOccScalarTerm Class Reference

Inheritance diagram for oaOccScalarTerm:

oaOccBitTerm oaOccTerm oaOccObject oaDesignObject oaObject


Public Methods

void getName (oaScalarName &name) const
oaScalarTerm * getTerm () const
oaModScalarTerm * getModTerm () const
void getName (oaName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaOccScalarTerm * find (const oaOccurrence *occurrence, const oaScalarName &name)

Detailed Description

The oaOccScalarTerm class implements a scalar (single-bit) terminal in the occurrence domain.

oaModScalarTerm, oaOccScalarTerm, and oaScalarTerm each represent scalar terminals on a different kind of master, where in each case the master represents a level of hierarchy in the design.

For oaOccScalarTerm, 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 occScalarTerms.

For oaModScalarTerm, the master is an oaModule. For oaScalarTerm, the master is an oaBlock, and the top block for the design will have a set of zero or more oaScalarTerms. Typically, many of the oaScalarTerms on the top oaBlock have a corresponding oaModScalarTerm on the top oaModule. The top oaOccurrence will have a corresponding oaOccScalarTerm for each scalarTerm in the union of the terminals between the top oaModule and the top oaBlock.

When oaScalarTerm objects are created in the block domain, the corresponding oaOccScalarTerm objects are automatically created on the top oaOccurrence.

Member Function Documentation

oaOccScalarTerm * oaOccScalarTerm::find (  const oaOccurrence *    occ,
const oaScalarName &    name
)  [static]
 

This function searches the specified occurrence for a scalarTerm with the specified name. The function returns a pointer to the oaOccScalarTerm if it is found. Otherwise, NULL is returned.

Parameters:
occ The occurrence to search
name The name of the scalar terminal to find
Returns:
A pointer to the scalar terminal, if found; otherwise, NULL is returned

oaModScalarTerm * oaOccScalarTerm::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 oaOccScalarTerm::getName (  oaScalarName &    name )  const
 

This function returns the name of this terminal in the name argument.

Parameters:
name The name of the scalar terminal to return

oaScalarTerm * oaOccScalarTerm::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.