oaOccInstHeader Class Reference

Inheritance diagram for oaOccInstHeader:

Public Methods
oaDesign *	getMaster () 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
oaOccInstHeader *	getSuperHeader () const
oaBoolean	isBound () const
oaBoolean	isSuperHeader () const
oaBoolean	isSubHeader () const
oaInstHeader *	getInstHeader () const
oaModInstHeader *	getModInstHeader () const
oaCollection< oaOccDesignInst, oaOccInstHeader >	getInsts (oaUInt4 filterFlags=oacInstIterNotImplicit, oaOccurrence *parentOcc=NULL) const
oaCollection< oaOccInstHeader, oaOccInstHeader >	getSubHeaders () const
Public Types
enum	{ dtIndex = oacInstHeaderDataType }

---

Detailed Description

The oaOccInstHeader class implements an object that contains information common to all the instances of a particular master design in a given parent occurrence. 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 oaOccInstHeader class can be observed by deriving from oaObserver<oaOccInstHeader>.

---

Member Function Documentation

void oaOccInstHeader::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 oaOccInstHeader::getCellName (  const oaNameSpace &    ns, oaString &    cellName )  const

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

void oaOccInstHeader::getCellName (  oaScalarName &    cellName )  const

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

oaInstHeader * oaOccInstHeader::getInstHeader (    )  const

This function returns the block domain object referenced by this occurrence instHeader.

oaCollection oaOccInstHeader::getInsts (  oaUInt4    filterFlags = oacInstIterNotImplicit, oaOccurrence *    occ = 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 occurrence is specified, the collection contains only the occInsts which directly belong to that occurrence 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 occ  Specifies that the collection should only contain those instances where the occurrence is the parent

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

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

void oaOccInstHeader::getLibName (  oaScalarName &    libName )  const

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

oaDesign * oaOccInstHeader::getMaster (    )  const

This function attempts to return the master associated with this design. If the instHeader is bound, the master is returned. Otherwise, NULL is returned.

oaModInstHeader * oaOccInstHeader::getModInstHeader (    )  const

This function returns the module domain object referenced by this occurrence instHeader.

void oaOccInstHeader::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 oaOccInstHeader::getSubHeaders (    )  const

This function returns a collection of subHeaders in this superHeader.

oaOccInstHeader * oaOccInstHeader::getSuperHeader (    )  const

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

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

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

void oaOccInstHeader::getViewName (  oaScalarName &    viewName )  const

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

oaBoolean oaOccInstHeader::isBound (    )  const

This function returns a boolean value that indicates if 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. Since there is only one occInstHeader for each distinct master design, shared by all occInsts within an instantiating design (regardless of which occurrence each occInst is in), this function does not indicate that there is a bound oaOccurrence for the master design. To check whether there is a bound occurrence for a given occInst, use oaOccInst::isBound().

oaBoolean oaOccInstHeader::isSubHeader (    )  const

This function returns a boolean value that indicates if this instHeader is a subHeader.

oaBoolean oaOccInstHeader::isSuperHeader (    )  const

This function returns a boolean value that indicates if this instHeader is a superHeader.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: dtIndex

---

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

• oaOccInstHeader.h
• oaOccInstHeader.dox

Return to top of page

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