oaModScalarNet Class Reference

Inheritance diagram for oaModScalarNet:

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
oaModScalarNet *	create (oaModule *module, const oaScalarName &name, oaSigType type=oacSignalSigType, oaBoolean isGlobal=false)
oaModScalarNet *	create (oaModule *module, oaSigType type=oacSignalSigType, oaBoolean isGlobal=false)
oaModScalarNet *	find (const oaModule *module, const oaScalarName &name)
oaBoolean	isValidName (const oaModule *module, const oaScalarName &name)

---

Detailed Description

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

---

Member Function Documentation

oaModScalarNet * oaModScalarNet::create (  oaModule *    module, oaSigType    type = oacSignalSigType, oaBoolean    isGlobal = false )  [static]

This function creates a scalarNet in the specified module with an automatically generated name. The default name prefix for automatically generated names is N__%d, where d is an integer that makes the name unique. Parameters: module  The module in which to create the net. This module may be any module inside of a cellview. type  The signal type; the default value is oacSignalSigType isGlobal  The flag to indicate whether this is a global net Exceptions: oacNetExists  oacImplicitModuleNetExists  oacImplicitBlockNetExists  oacScalarNetNameMatchesBusBaseName  oacInvalidHierNetName

oaModScalarNet * oaModScalarNet::create (  oaModule *    module, const oaScalarName &    name, oaSigType    sigType = oacSignalSigType, oaBoolean    isGlobal = false )  [static]

This function creates a scalarNet with the specified name in the given module. The function checks the specified name to verify it is unused. If the name is used on an implicit net, that implicit net is set to explicit and nothing else is processed. Parameters: module  The module in which to create the net. This module may be any module inside of a design. name  The name of the scalar net to create sigType  The signal type isGlobal  The flag to indicate global net; the default is false Exceptions: oacNetExists  oacImplicitModuleNetExists  oacImplicitBlockNetExists  oacScalarNetNameMatchesBusBaseName  oacInvalidHierNetName

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

This function searches the specified module for a scalarNet with the specified name. The function returns the net if it is found. Otherwise, NULL is returned. Parameters: module  The module to search name  The scalar net name to find Returns: The scalar net name or NULL

void oaModNet::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 oaModNet::getName (  oaName &    name )  const

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

void oaModScalarNet::getName (  oaScalarName &    name )  const

This function returns the name of this scalar net. Parameters: name  The net name to return

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

This function returns a boolean value that indicates if the specified name is valid for a new oaModScalarNet in the specified module. Parameters: module  The module to search name  The scalar net name to find

void oaModScalarNet::setName (  const oaScalarName &    name )

This function sets the name of this oaModScalarNet object. The name is also updated for each of the occurrences that the net appears in. Parameters: name  The new name to be set for this net. Exceptions: oacNetExists  oacImplicitModuleNetExists  oacImplicitBlockNetExists  oacScalarNetNameMatchesBusBaseName  oacInvalidHierNetName  oacCannotSetNameOfNetInBundleNet

---

The documentation for this class was generated from the following files:

• oaModScalarNet.h
• oaModScalarNet.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.