oaModScalarInst Class Reference

Inheritance diagram for oaModScalarInst:

oaModBitInst oaModDesignInst oaModInst oaModObject oaDesignObject oaObject


Public Methods

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

Static Public Methods

oaModScalarInst * create (oaModule *module, oaDesign *master, const oaScalarName &name, const oaParamArray *params=NULL)
oaModScalarInst * create (oaModule *module, oaDesign *master, const oaParamArray *params=NULL)
oaModScalarInst * create (oaModule *module, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, const oaScalarName &name, const oaParamArray *params=NULL)
oaModScalarInst * create (oaModule *module, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, const oaParamArray *params=NULL)
oaModScalarInst * find (const oaModule *module, const oaScalarName &name)
oaBoolean isValidName (const oaModule *module, const oaScalarName &name)

Detailed Description

The oaModScalarInst class implements a scalar (single-bit) instance of design master. Scalar inst is the most common kind of instance. This class has a simple name with no index.

oaModScalarInst objects are always in the module domain.

Member Function Documentation

oaModScalarInst * oaModScalarInst::create (  oaModule *    module,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
const oaParamArray *    params = NULL
)  [static]
 

This function creates an oaModScalarInst object with the specified attributes. The name for the instance is generated automatically by this create function, with the default name prefix I__%d, where d refers to an integer it will generate to make this name unique.

Parameters:
module The module in which to create the instance
libName The libName of the instance master
cellName The cellName of the instance master
viewName The viewName of the instance master
params Optional parameter array for pCell instances

oaModScalarInst * oaModScalarInst::create (  oaModule *    module,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
const oaScalarName &    name,
const oaParamArray *    params = NULL
)  [static]
 

This function creates an oaModScalarInst object with the specified attributes. The name for the instance is specified. Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
module The module in which to create the instance
libName The libName of the instance master
cellName The cellName of the instance master
viewName The viewName of the instance master
name The instance name
params Optional parameter array for pCell instances
Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaModScalarInst * oaModScalarInst::create (  oaModule *    module,
oaDesign *    master,
const oaParamArray *    params = NULL
)  [static]
 

This function create an oaModScalarInst object with the specified attributes. This function lets you specify the master design. A name for the new instance is automatically generated.

Parameters:
module The module in which to create the instance
master A pointer to the instance master
params Optional parameter array for pCell instances
Exceptions:
oacInvalidSuperMaster 

oaModScalarInst * oaModScalarInst::create (  oaModule *    module,
oaDesign *    master,
const oaScalarName &    name,
const oaParamArray *    params = NULL
)  [static]
 

This function create an oaModScalarInst object with the specified attributes. This function lets you specify the master design and name for the new instance.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exist with the given name

Parameters:
module The module in which to create the instance
master A pointer to the instance master
name The instance name
params Optional parameter array for pCell instances
Exceptions:
oacInvalidSuperMaster 
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

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

This function searches the specified module for a module scalarInst with the specified name. If the name is found, the function returns the module scalar instance. Otherwise, NULL is returned.

Returns:
The oaModScalarInst pointer or NULL

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

This function fills out name with the name of this instance. The name is mapped according to the specified nameSpace.

Parameters:
ns The nameSpace used to map the name
name The returned instance name

void oaModInst::getName (  oaSimpleName &    name )  const
 

This function fills out name with the name of this instance.

Parameters:
name The returned instance name

void oaModScalarInst::getName (  oaScalarName &    name )  const
 

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

oaBoolean oaModScalarInst::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 oaModScalarInst in the specified module.

Exceptions are thrown if:

  • the specified name does not imply a scalar name
  • an instance already exists with the specified name
  • a vectorInstDef exists with the specified name

Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

void oaModScalarInst::setName (  const oaScalarName &    name ) 
 

This function sets the name for this scalar inst.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
name The new name to be set for this instance.
Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

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.