oaScalarTerm Class Reference

Inheritance diagram for oaScalarTerm:

oaBitTerm oaTerm oaBlockObject 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

oaScalarTerm * create (oaBitNet *net, const oaScalarName &name, oaTermType type=oacInputOutputTermType, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaScalarTerm * find (const oaBlock *block, const oaScalarName &name)
oaBoolean isValidName (const oaBlock *block, const oaScalarName &name)

Detailed Description

The oaScalarTerm class implements a scalar terminal on an oaBlock. Scalar terminals are single bit and have a name without an index. A scalar terminal must be created on a single-bit net, though the net name does not have to be scalar.

oaScalarTerm objects are always in the block domain. oaScalarTerms may be physical-only terminals that are only in the block hierarchy, or they can be cross-domain terminals that directly correspond to an oaModScalarTerm in the module domain and an oaOccScalarTerm in the occurrence domain.

Member Function Documentation

oaScalarTerm * oaScalarTerm::create (  oaBitNet *    net,
const oaScalarName &    name,
oaTermType    type = oacInputOutputTermType,
oaBlockDomainVisibility    view = oacInheritFromTopBlock
)  [static]
 

This function creates an oaScalarTerm object on the specified net with the specified attributes. The function checks the net to verify that it is valid.

Parameters:
net The bit net to check
name The name of the scalar terminal to create
type The terminal type
view Specifies whether this net is visible in the module domain
Returns:
A pointer to the created scalar terminal
Exceptions:
oacCannotCreateTermWithImplicitNet 
oacTermExists 
oacTermMemberExists 
oacScalarTermNameMatchesBusBaseName 
oacImplicitModuleTermExists 
oacInvalidHierTermName 
oacTermNetMustBeInUniqueOccHier 
oacOverridingTermAlreadyExist 
oacCannotBlockOverrideNetSignalType 
oacPhysOnlyTermNetMustBeInSameOcc 

oaScalarTerm * oaScalarTerm::find (  const oaBlock *    block,
const oaScalarName &    name
)  [static]
 

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

Parameters:
block The block 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 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 oaScalarTerm::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 oaScalarTerm::isValidName (  const oaBlock *    block,
const oaScalarName &    name
)  [static]
 

This function returns a boolean value that indicates if specified name is valid for a new oaScalarTerm object on the specified block. This function also returns true if the name corresponds to a scalarTerm that was hidden but not overridden.

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

void oaScalarTerm::setName (  const oaScalarName &    name ) 
 

This function changes the name of this terminal to the specified name.

Parameters:
name The new terminal name
Exceptions:
oacCannotSetNameOfImplicitTerm 
oacCannotSetNameOfTermInBundleTerm 
oacScalarTermNameMatchesBusBaseName 
oacTermExists 

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.