oaScalarNet Class Reference

Inheritance diagram for oaScalarNet:

oaBitNet oaNet 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

oaScalarNet * create (oaBlock *block, const oaScalarName &name, oaSigType sigType=oacSignalSigType, oaBoolean isGlobal=false, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaScalarNet * create (oaBlock *block, oaSigType sigType=oacSignalSigType, oaBoolean isGlobal=false, oaBlockDomainVisibility view=oacInheritFromTopBlock)
oaScalarNet * find (const oaBlock *block, const oaScalarName &name)
oaBoolean isValidName (const oaBlock *block, const oaScalarName &name)

Detailed Description

The oaScalarNet class implements a scalar (single-bit) net.

Member Function Documentation

oaScalarNet * oaScalarNet::create (  oaBlock *    block,
oaSigType    sigType = oacSignalSigType,
oaBoolean    isGlobal = false,
oaBlockDomainVisibility    view = oacInheritFromTopBlock
)  [static]
 

This function creates a scalarNet in the specified block with an automatically generated name. The default name prefix for automatically generated names is N__%d, d referring to a unique integer.

Parameters:
block The block name
sigType The signal type; the default value is oacSignalSigType
isGlobal The flag to indicate global net; the default is false
view Specifies whether this net is visible in the module domain
Exceptions:
oacScalarNetNameMatchesBusBaseName 

oaScalarNet * oaScalarNet::create (  oaBlock *    block,
const oaScalarName &    name,
oaSigType    sigType = oacSignalSigType,
oaBoolean    isGlobal = false,
oaBlockDomainVisibility    view = oacInheritFromTopBlock
)  [static]
 

This function verifies that a net with the specified name does not exist and creates an oaScalarNet with the specified name and attributes. If an oaScalarNet already exists, but it is implicit, this function promotes the net to an explicit state and updates the sigType and isGlobal attributes accordingly. If the name argument implies a hierarchical name, the path portion of the name must specify an already existing occurrence hierarchy and the path must not extend below the current design boundary.

Parameters:
block The block name
name The local or hierarchical name of the scalar net to create
sigType The signal type
isGlobal The flag to indicate global net; the default is false
view Specifies whether this net is visible in the module domain
Exceptions:
oacNetExists 
oacScalarNetNameMatchesBusBaseName 
oacHierPathDoesNotExist 
oacHierPathCrossDesign 

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

This function searches the specified block for an oaScalarNet with the specified name. The path portion of the name must specify the path to an existing occurrence in the design. A hierarchical name is considered an alias that identifies an oaOccNet in the occurrence domain. If the specified name is hierarchical, the return value is the canonical net in the block domain for the specified alias. If the net is not found, NULL is returned.

Parameters:
block The block to search
name The local or hierarchical scalar net name to find

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

This function returns the name of this net in the specified nameSpace in the specified name string.

void oaNet::getName (  oaName &    name )  const
 

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

void oaScalarNet::getName (  oaScalarName &    name )  const
 

This function returns the name of this scalar net.

Parameters:
name The net name to return

oaBoolean oaScalarNet::isValidName (  const oaBlock *    block,
const oaScalarName &    name
)  [static]
 

This function returns a boolean value that indicates if the specified name is valid for a new oaScalarNet in the specified block.

Parameters:
block The block to search
name The scalar net name to find

void oaScalarNet::setName (  const oaScalarName &    name ) 
 

This function changes the name of this net to the specified name. If the net is hierarchical, the name must be a hierarchical name and the path portion must match that associated with the net. For example, to change the base name A to base name B in the hierarchical net I1/I2/A, you must specify I1/I2/B as the name. This function fails if this net is an implicit net or this net is a net in a bundle net.

Parameters:
name The new local or hierarchical name for the scalar net
Exceptions:
oacCannotSetNameOfImplicitNet 
oacCannotSetNameOfNetInBundleNet 
oacNetExists 
oacScalarNetNameMatchesBusBaseName 
oacHierPathDoesNotExist 
oacHierPathCrossDesign 
oacMismatchedHierPath 

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.