oaModDesignInst Class Reference

Inheritance diagram for oaModDesignInst:

oaModInst oaModObject oaDesignObject oaObject oaModBitInst oaModVectorInst oaModScalarInst oaModVectorInstBit


Public Methods

oaDesign * getMaster () const
oaModInstHeader * getHeader () const
void getParams (oaParamArray &params) const
void getLibName (oaScalarName &libName) const
void getCellName (oaScalarName &cellName) const
void getViewName (oaScalarName &viewName) const
void getLibName (const oaNameSpace &ns, oaString &libName) const
void getCellName (const oaNameSpace &ns, oaString &cellName) const
void getViewName (const oaNameSpace &ns, oaString &viewName) const
oaBoolean findParam (const oaString &name, oaParam &param)
void setMaster (oaDesign *master)
void setMaster (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
void setParams (const oaParamArray &params)

Detailed Description

The oaModDesignInst class is a base for instances of a design master.

oaModDesignInst objects are always in the module domain.

Member Function Documentation

oaBoolean oaModDesignInst::findParam (  const oaString &    name,
oaParam &    param
) 
 

This function searches the parameter list of this instance for a parameter with the specified name. If found, it fills out param with the appropriate attributes and returns true. Otherwise, the function returns false. Only Pcell instances have parameters.

Parameters:
name The parameter name to find
param The parameter class to fill out if the parameter is found

void oaModDesignInst::getCellName (  const oaNameSpace &    ns,
oaString &    cellName
)  const
 

This function returns the cell name for the master design referenced by this instance in the namespace specified.

Parameters:
ns The namespace for the cell name
cellName The cell name for the master design

void oaModDesignInst::getCellName (  oaScalarName &    cellName )  const
 

This function returns the cell name for the master design referenced by this instance.

Parameters:
cellName The name of the cell for the master design

oaModInstHeader * oaModDesignInst::getHeader (    )  const
 

This function returns the instHeader associated with this instance. The instHeader is a collection of the attributes that are common to all instances of a particular master. For Pcell instances, this function returns the subheader.

Returns:
The pointer to the instance header

void oaModDesignInst::getLibName (  const oaNameSpace &    ns,
oaString &    libName
)  const
 

This function returns the library name for the master design referenced by this instance in the namespace specified.

Parameters:
ns The namespace for the library name
libName The library name for the master design

void oaModDesignInst::getLibName (  oaScalarName &    libName )  const
 

This function returns the library name for the master design referenced by this instance.

Parameters:
libName The name of the library for the master design

oaDesign * oaModDesignInst::getMaster (    )  const
 

This function attempts to return the master associated with this instance. If the instance is not previously bound, it attempts to open the master and bind this instance. If the instance cannot be bound, NULL is returned.

void oaModDesignInst::getParams (  oaParamArray &    params )  const
 

This function fills out params with the parameters of this instance. Only Pcell instances have parameters. This call only returns the parameters that were specified during creation or through calls to setParams(). If invoked on an inst that is not a Pcell or if no parameter is specified for the instance, the returned params paramArray will have a numParams of zero.

void oaModDesignInst::getViewName (  const oaNameSpace &    ns,
oaString &    viewName
)  const
 

This function returns the view name for the master design referenced by this instance in the namespace specified.

Parameters:
ns The namespace for the view name
viewName The view name for the master design

void oaModDesignInst::getViewName (  oaScalarName &    viewName )  const
 

This function returns the view name for the master design referenced by this instance.

Parameters:
viewName The name of the view for the master design

void oaModDesignInst::setMaster (  const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName
) 
 

This function sets the master of this instance. This version sets the master to the design specified by the specified library, cell, and view names and does not force the master to open.

Parameters:
libName The library name for the new instance master
cellName The cell name for the new instance master
viewName The view name for the new instance master

void oaModDesignInst::setMaster (  oaDesign *    master ) 
 

This function sets the master of this instance. This version sets the master to the specified design.

Parameters:
master The pointer to the new instance master
Exceptions:
oacInvalidSuperMaster 

void oaModDesignInst::setParams (  const oaParamArray &    params ) 
 

This function sets the parameters of this instance to the specified list. If this instance already has parameters attached to it, the existing parameters are replaced.

The oaParamArray is any subset of the master's oaParamArray definition. Any parameter omitted is given the default value from the master.

Parameters:
params The array of parameters to apply to the instance
Exceptions:
oacInvalidPcellMaster 
oacPcellMasterNotBound 

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.