oaModScalarTerm Class Reference

Inheritance diagram for oaModScalarTerm:

oaModBitTerm oaModTerm oaModObject oaDesignObject oaObject


Public Methods

void getName (oaScalarName &name) const
void setName (const oaScalarName &name)
void getName (oaName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaModScalarTerm * create (oaModBitNet *modNet, const oaScalarName &name, oaTermType type=oacInputOutputTermType)
oaModScalarTerm * find (const oaModule *module, const oaScalarName &name)
oaBoolean isValidName (const oaModule *module, const oaScalarName &name)

Detailed Description

The oaModScalarTerm class implements a scalar (single-bit) terminal in the module 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 oaModScalarTerm, the master is an oaModule, and each module in a design will have a set of zero or more modScalarTerms. For oaOccScalarTerm, the master is an oaOccurrence.

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. All of the oaScalarTerms on the top oaBlock have a corresponding oaOccScalarTerm on the top oaOccurrence.

When oaScalarTerm objects are created in the block domain, the corresponding oaModScalarTerm objects are automatically created on the top oaModule.

Member Function Documentation

oaModScalarTerm * oaModScalarTerm::create (  oaModBitNet *    modNet,
const oaScalarName &    name,
oaTermType    type = oacInputOutputTermType
)  [static]
 

This function creates a terminal with the given scalar name connected to the specified module net.

Parameters:
modNet The module bitNet to create the terminal with
name The name to use for the terminal
type The type of terminal to create
Exceptions:
oacCannotCreateTermWithImplicitNet 

oaModScalarTerm * oaModScalarTerm::find (  const oaModule *    module,
const oaScalarName &    name
)  [static]
 

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

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

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 oaModScalarTerm::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

oaBoolean oaModScalarTerm::isValidName (  const oaModule *    module,
const oaScalarName &    name
)  [static]
 

This function returns a boolean value that indicates if specified name is valid for a new oaModScalarTerm on the specified module.

Parameters:
module The module to search
name The name of the scalar terminal to return

void oaModScalarTerm::setName (  const oaScalarName &    name ) 
 

This function sets the name of this oaModScalarTerm object. The name is also updated for each occurrence that the term appears in.

Parameters:
name The new name to be set for this term.
Exceptions:
oacCannotSetNameOfImplicitTerm 
oacCannotSetNameOfOverriddenTerm 
oacCannotSetNameOfTermInBundleTerm 

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.