oaModInstHeader Class Reference

Inheritance diagram for oaModInstHeader:

Public Methods
oaDesign *	getMaster () const
oaModule *	getMasterModule () 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
void	getParams (oaParamArray &params) const
void	getAllParams (oaParamArray &params) const
oaModInstHeader *	getSuperHeader () const
oaBoolean	isBound () const
oaBoolean	isSuperHeader () const
oaBoolean	isSubHeader () const
oaCollection< oaModDesignInst, oaModInstHeader >	getInsts (oaUInt4 filterFlags=oacInstIterNotImplicit, oaModule *parentModule=NULL) const
oaCollection< oaModInstHeader, oaModInstHeader >	getSubHeaders () const
Static Public Methods
oaModInstHeader *	find (const oaDesign *design, const oaDesign *master)
oaModInstHeader *	find (const oaDesign *design, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
Public Types
enum	{ dtIndex = oacInstHeaderDataType }

---

Detailed Description

The oaModInstHeader class implements an object that contains information common to all the instances of a particular master oaDesign in a given parent module. For instances of Pcells, there are two kinds of instHeaders:

• SuperHeaders represent all of the instances of a Pcell master, regardless of parameter settings
• SubHeaders represent all of the instances that have one specific set of parameter values

Every instance of a Pcell has exactly one subHeader, which, in turn, has exactly one superHeader. InstHeaders for instances that are not Pcells are neither subheaders nor superheaders.

The oaModInstHeader class can be observed by deriving from oaObserver<oaModInstHeader>.

---

Member Function Documentation

oaModInstHeader * oaModInstHeader::find (  const oaDesign *    design, const oaScalarName &    libName, const oaScalarName &    cellName, const oaScalarName &    viewName )  [static]

This function searches the specified design for an instHeader with the specified master design library, cell, and view names. If the specified master is a Pcell, the superMaster is returned.

oaModInstHeader * oaModInstHeader::find (  const oaDesign *    design, const oaDesign *    master )  [static]

This function searches the specified design for an instHeader with the specified master design. If the specified master is a Pcell, the superMaster is returned.

void oaModInstHeader::getAllParams (  oaParamArray &    params )  const

This function fills out params with the parameters associated with this instHeader and the parameters associated with the superMaster. If this instHeader is not associated with parameters, params will have a numParams value of zero.

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

This function returns the cell name of the master oaDesign referenced by this modInstHeader. Parameters: ns  The namespace in which to return the cell name. cellName  The returned cell name.

void oaModInstHeader::getCellName (  oaScalarName &    cellName )  const

This function returns the cell name of the master oaDesign referenced by this modInstHeader. Parameters: cellName  The returned cell name.

oaCollection oaModInstHeader::getInsts (  oaUInt4    filterFlags = oacInstIterNotImplicit, oaModule *    module = NULL )  const

This function returns a collection of instances associated with this instHeader. The filter flag bits are defined below and may be logically OR'd together to refine the contents of the collection. If the optional parentModule is specified, the collection contains only the modInsts which directly belong to that module as parent. Parameters: filterFlags  Specifies what the collection contains. The bit flags are defined as follows: oacInstIterSingleBit: the collection contains single-bit instances oacInstIterNotImplicit: the collection will not contain any implicitly created instances module  Specifies that the collection should only contain those instances where the module is the parent

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

This function returns the library name of the master oaDesign referenced by this modInstHeader. Parameters: ns  The namespace in which to return the library name. libName  The returned library name.

void oaModInstHeader::getLibName (  oaScalarName &    libName )  const

This function returns the library name of the master oaDesign referenced by this modInstHeader. Parameters: libName  The returned library name.

oaDesign * oaModInstHeader::getMaster (    )  const

This function returns the master associated with this instHeader. If this instHeader isn't bound, an attempt is made to bind it. A pointer to the master design is returned if this instHeader is, or was successfully, bound. Otherwise, NULL is returned.

oaModule * oaModInstHeader::getMasterModule (    )  const

This function returns the top module of the design associated with this instHeader. If this instHeader isn't bound, an attempt is made to bind it. A pointer to the top module in the bound master design is returned if this instHeader is, or was successfully, bound. Otherwise, NULL is returned. Note that NULL may also be returned if the bound master design has no top module.

void oaModInstHeader::getParams (  oaParamArray &    params )  const

This function fills out params with the parameters associated with this instHeader. This call only returns the non-default parameters that were specified during creation or through calls to setParams() on the instances. If this instHeader is not associated with a Pcell master or uses all default parameters, params will have a numParams of zero.

oaCollection oaModInstHeader::getSubHeaders (    )  const

This function returns a collection of subHeaders in this superHeader.

oaModInstHeader * oaModInstHeader::getSuperHeader (    )  const

This function returns the superHeader of this instHeader. The function returns NULL if it is not a subHeader.

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

This function returns the view name of the master oaDesign referenced by this modInstHeader. Parameters: ns  The namespace in which to return the view name. viewName  The returned view name.

void oaModInstHeader::getViewName (  oaScalarName &    viewName )  const

This function returns the view name of the master oaDesign referenced by this modInstHeader. Parameters: viewName  The returned view name.

oaBoolean oaModInstHeader::isBound (    )  const

This function returns a boolean value indicating whether this instHeader is bound to its master design. A bound master means the master is read in and the linkage from the instHeader is established by traversing from an instance to that master.

oaBoolean oaModInstHeader::isSubHeader (    )  const

This function returns a boolean value indicating whether this instHeader is a subHeader.

oaBoolean oaModInstHeader::isSuperHeader (    )  const

This function returns a boolean value indicating whether this instHeader is a superHeader.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: dtIndex

---

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

• oaModInstHeader.h
• oaModInstHeader.dox

Return to top of page

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