oaModModuleInstHeader Class Reference

Inheritance diagram for oaModModuleInstHeader:

oaModObject oaDesignObject oaObject


Public Methods

oaModule * getMasterModule () const
void getName (oaScalarName &name) const
void getName (const oaNameSpace &ns, oaString &name) const
oaBoolean isBound () const
oaCollection< oaModModuleInst, oaModModuleInstHeader > getInsts (oaUInt4 filterFlags=oacInstIterNotImplicit) const

Static Public Methods

oaModModuleInstHeader * find (const oaModule *module, const oaModule *master)
oaModModuleInstHeader * find (const oaModule *module, const oaScalarName &masterModuleName)

Public Types

enum  { dtIndex = oacModuleInstHeaderDataType }

Detailed Description

The oaModModuleInstHeader class implements an object that contains information common to all the logical instances of a particular master module in a given parent module. oaModModuleInstHeader objects are scoped within the parent module.

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

Member Function Documentation

oaModModuleInstHeader * oaModModuleInstHeader::find (  const oaModule *    module,
const oaScalarName &    masterModuleName
)  [static]
 

This function searches the specified module looking for an instHeader with the specified master module name.

Parameters:
module The module to be searched
masterModuleName The name of the master module

oaModModuleInstHeader * oaModModuleInstHeader::find (  const oaModule *    module,
const oaModule *    master
)  [static]
 

This function searches the specified module for an instHeader with the specified master module. If the specified master is a pCell, the superHeader is returned.

oaCollection oaModModuleInstHeader::getInsts (  oaUInt4    filterFlags = oacInstIterNotImplicit )  const
 

This function returns a collection of module instances associated with this instHeader. These instances refer to master modules embedded within the containing design. The filter flag bits are defined below and may be logically OR'd together to refine the contents of the collection.

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

oaModule * oaModModuleInstHeader::getMasterModule (    )  const
 

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

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

This function returns the name referenced by this instHeader. The second version returns the name in the nameSpace specified.

Parameters:
ns The namespace for the name
name The master module name

void oaModModuleInstHeader::getName (  oaScalarName &    name )  const
 

This function returns the name referenced by this instHeader. The second version returns the name in the nameSpace specified.

Parameters:
name The master module name

oaBoolean oaModModuleInstHeader::isBound (    )  const
 

This function returns a boolean value that indicates if this instHeader is bound to its master module. 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.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.