oaOccScalarInst Class Reference

Inheritance diagram for oaOccScalarInst:

oaOccBitInst oaOccDesignInst oaOccInst oaOccObject oaDesignObject oaObject


Public Methods

void getName (oaScalarName &name) const
void getPathName (oaScalarName &pathName) const
oaScalarInst * getInst () const
oaModScalarInst * getModInst () const
void getName (oaSimpleName &name) const
void getName (const oaNameSpace &ns, oaString &name) const
void getPathName (oaSimpleName &pathName) const
void getPathName (const oaNameSpace &ns, oaString &pathName) const

Static Public Methods

oaOccScalarInst * find (const oaOccurrence *occurrence, const oaScalarName &name)

Detailed Description

The oaOccScalarInst class implements a occurence scalar (single-bit) instance. This is the most common kind of instance. This class has a simple name with no index.

oaOccScalarInst objects are always in the occurrence domain.

Member Function Documentation

oaOccScalarInst * oaOccScalarInst::find (  const oaOccurrence *    occurrence,
const oaScalarName &    name
)  [static]
 

This function searches the specified occurrence looking for a scalarInst with the specified name. If name is hierarchical, this function will descend into lower levels of occurrence hierarchy, expanding the hierarchy and binding the master designs as needed. The scalarInst is returned if found, otherwise NULL is returned.

Parameters:
occurrence The occurrence in which to search
name The name of the net to find
Returns:
A pointer to the oaOccScalarInst

oaScalarInst * oaOccScalarInst::getInst (    )  const
 

This function returns the corresponding instance in the block domain. NULL will be returned if the master design for this instance does not have a top block.

Returns:
A pointer to an oaOccScalarInst

Reimplemented from oaOccInst.

oaModScalarInst * oaOccScalarInst::getModInst (    )  const
 

This function returns the corresponding instance in the module domain. NULL will be returned if this instance is an occurrence of a physical-only instance.

Returns:
A pointer to an oaModScalarInst

Reimplemented from oaOccInst.

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

This function fills out name with the name of this instance. The name is mapped according to the specified nameSpace.

Parameters:
ns The nameSpace used to map the name
name The returned instance name

void oaOccInst::getName (  oaSimpleName &    name )  const
 

This function fills out name with the name of this instance.

Parameters:
name The returned instance name

void oaOccScalarInst::getName (  oaScalarName &    name )  const
 

This function returns the local name of this scalarInst in the specified name object. The name is relative to the parent occurrence of this scalarInst.

Parameters:
name The returned instance name

void oaOccInst::getPathName (  const oaNameSpace &    ns,
oaString &    pathName
)  const
 

This function returns the full path name of this instance in the specified nameSpace in the specified pathName string. The pathName is relative to the top occurrence in the occurrence hierarchy containing this instance.

Parameters:
ns The nameSpace in which to return the name
pathName The path name of the instance

void oaOccInst::getPathName (  oaSimpleName &    pathName )  const
 

This function fills out pathName with the full path name of this instance, relative to the top occurrence in the occurrence hierarchy containing this instance.

Parameters:
pathName The path name of the instance

void oaOccScalarInst::getPathName (  oaScalarName &    pathName )  const
 

This function returns the full path name of this scalarInst, relative to the top occurrence in the occurrence hierarchy containing this scalarInst.

Parameters:
pathName The returned path name

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.