oaOccVectorInstBit Class Reference

Inheritance diagram for oaOccVectorInstBit:

oaOccBitInst oaOccDesignInst oaOccInst oaOccObject oaDesignObject oaObject


Public Methods

oaVectorInstBit * getInst () const
oaModVectorInstBit * getModInst () const
oaOccVectorInstDef * getDef () const
oaUInt4 getBitIndex () const
void getName (oaVectorBitName &name) const
void getPathName (oaVectorBitName &pathName) 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

oaOccVectorInstBit * find (const oaOccurrence *occurrence, const oaScalarName &baseName, oaUInt4 bitIndex)

Detailed Description

The oaOccVectorInstBit class implements a single bit of an occurrence vectorInst.

oaOccVectorInstBit objects are always in the occurrence domain.

Member Function Documentation

oaOccVectorInstBit * oaOccVectorInstBit::find (  const oaOccurrence *    occurrence,
const oaScalarName &    baseName,
oaUInt4    bitIndex
)  [static]
 

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

Parameters:
occurrence The occurrence in which to search
baseName The base name of the instance to find
bitIndex The bit index of the instance to find
Returns:
A pointer to the oaOccVectorInstBit

oaUInt4 oaOccVectorInstBit::getBitIndex (    )  const
 

This function returns the bitIndex of this vectorInstBit.

oaOccVectorInstDef * oaOccVectorInstBit::getDef (    )  const
 

This function returns a pointer to the vectorInstDef for this vectorInstBit.

oaVectorInstBit * oaOccVectorInstBit::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 oaOccVectorInstBit

Reimplemented from oaOccInst.

oaModVectorInstBit * oaOccVectorInstBit::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 oaModVectorInstBit

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 oaOccVectorInstBit::getName (  oaVectorBitName &    name )  const
 

This function returns the name of this occVectorInstBit.

Parameters:
name The name of the occVectorInstBit to return

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 oaOccVectorInstBit::getPathName (  oaVectorBitName &    pathName )  const
 

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

Parameters:
pathName The pathName of the occVectorInstBit to return

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.