oaOccModuleInstHeader Class Reference

Inheritance diagram for oaOccModuleInstHeader:

oaOccObject oaDesignObject oaObject


Public Methods

oaModule * getMaster () const
oaOccurrence * getMasterOccurrence (oaBoolean expand=true) const
void getName (oaScalarName &name) const
void getName (const oaNameSpace &ns, oaString &name) const
oaBoolean isBound () const
oaModModuleInstHeader * getModModuleInstHeader () const
oaCollection< oaOccModuleInst, oaOccModuleInstHeader > getInsts (oaUInt4 filterFlags=oacInstIterNotImplicit) const

Public Types

enum  { dtIndex = oacModuleInstHeaderDataType }

Detailed Description

The oaOccModuleInstHeader class implements an object that contains information common to all the logical instances of a particular master module in a given parent occurrence. oaOccModuleInstHeader objects is in occurrence domain and is scoped within the owner occurrence.

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

Member Function Documentation

oaCollection oaOccModuleInstHeader::getInsts (  oaUInt4    filterFlags = oacInstIterNotImplicit )  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.

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 * oaOccModuleInstHeader::getMaster (    )  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.

oaOccurrence * oaOccModuleInstHeader::getMasterOccurrence (  oaBoolean    expand = true )  const
 

This function attempts to return the occurrence master associated with this module instHeader. If expand is true and the instHeader cannot be bound, NULL is returned.

Parameters:
expand Specifies whether to expand the occurrence hierarchy to include the master occurrence for this instHeader, if it has not yet been expanded in the current session.

oaModModuleInstHeader * oaOccModuleInstHeader::getModModuleInstHeader (    )  const
 

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

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

This function returns the module name referenced by this instHeader in the specified nameSpace in the specified name string.

Parameters:
ns The namespace used to map the name
name The returned name string

void oaOccModuleInstHeader::getName (  oaScalarName &    name )  const
 

This function returns the module name referenced by this instHeader in the specified name argument.

Parameters:
name The returned name as an oaScalarName

oaBoolean oaOccModuleInstHeader::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.