oaScalarInst Class Reference

Inheritance diagram for oaScalarInst:

oaBitInst oaInst oaRef oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

void getName (oaScalarName &name) const
void setName (const oaScalarName &name)
oaScalarInst * copy (const oaScalarName &name, const oaTransform &xform)
oaScalarInst * copy (const oaScalarName &name, const oaTransform &xform, oaBlock *block)
void getName (oaSimpleName &name) const
void getName (const oaNameSpace &ns, oaString &name) const

Static Public Methods

oaScalarInst * create (oaBlock *block, oaDesign *master, const oaScalarName &name, const oaTransform &xform, const oaParamArray *params=NULL, oaBlockDomainVisibility view=oacInheritFromTopBlock, oaPlacementStatus status=oacNonePlacementStatus)
oaScalarInst * create (oaBlock *block, oaDesign *master, const oaTransform &xform, const oaParamArray *params=NULL, oaBlockDomainVisibility view=oacInheritFromTopBlock, oaPlacementStatus status=oacNonePlacementStatus)
oaScalarInst * create (oaBlock *block, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, const oaScalarName &name, const oaTransform &xform, const oaParamArray *params=NULL, oaBlockDomainVisibility view=oacInheritFromTopBlock, oaPlacementStatus status=oacNonePlacementStatus)
oaScalarInst * create (oaBlock *block, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, const oaTransform &xform, const oaParamArray *params=NULL, oaBlockDomainVisibility view=oacInheritFromTopBlock, oaPlacementStatus status=oacNonePlacementStatus)
oaScalarInst * find (const oaBlock *block, const oaScalarName &name)
oaBoolean isValidName (const oaBlock *block, const oaScalarName &name)

Detailed Description

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

oaScalarInst objects are always in the block domain. They may be physical-only instances that are only in the block hierarchy, or they can be cross-domain instances that directly correspond to an oaModScalarInst in the module domain and an oaOccScalarInst in the occurrence domain.

Member Function Documentation

oaScalarInst * oaScalarInst::copy (  const oaScalarName &    name,
const oaTransform &    xform,
oaBlock *    block
) 
 

This function creates a copy of this instance. The name of the new instance is specified in name. The new copied instance is copied to the location based on the specified transform. This function creates a copy of the instance in the specified block which may be in a different design.

Parameters:
name The name for the new instance
xform The transform for the new instance
block The oaBlock for the new instance

oaScalarInst * oaScalarInst::copy (  const oaScalarName &    name,
const oaTransform &    xform
) 
 

This function creates a copy of this instance. The name of the new instance is specified in name. The new copied instance is copied to the location based on the specified transform. This function creates a copy of the instance within the same block.

Parameters:
name The name for the new instance
xform The transform for the new instance

oaScalarInst * oaScalarInst::create (  oaBlock *    block,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
const oaTransform &    xform,
const oaParamArray *    params = NULL,
oaBlockDomainVisibility    view = oacInheritFromTopBlock,
oaPlacementStatus    status = oacNonePlacementStatus
)  [static]
 

This function creates an oaScalarInst object with the specified attributes. The name for the instance is generated automatically by this create function, with the default name prefix I__%d, where d refers to an integer it will generate to make this name unique.

Parameters:
block The block in which to create the instance
libName The libName of the instance master
cellName The cellName of the instance master
viewName The viewName of the instance master
xform The transform for the instance
params Optional parameter array for pCell instances
view Specifies whether this instance is visible in the module domain
status Specifies the placement status of this instance
Exceptions:
oacParamsSuppliedForNonPCellInstMaster 

oaScalarInst * oaScalarInst::create (  oaBlock *    block,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
const oaScalarName &    name,
const oaTransform &    xform,
const oaParamArray *    params = NULL,
oaBlockDomainVisibility    view = oacInheritFromTopBlock,
oaPlacementStatus    status = oacNonePlacementStatus
)  [static]
 

This function creates an oaScalarInst object with the specified attributes. The name for the instance is specified. Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Parameters:
block The block in which to create the instance
libName The libName of the instance master
cellName The cellName of the instance master
viewName The viewName of the instance master
name The instance name
xform The transform for the instance
params Optional parameter array for pCell instances
view Specifies whether this instance is visible in the module domain
status Specifies the placement status of this instance
Exceptions:
oacParamsSuppliedForNonPCellInstMaster 
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaScalarInst * oaScalarInst::create (  oaBlock *    block,
oaDesign *    master,
const oaTransform &    xform,
const oaParamArray *    params = NULL,
oaBlockDomainVisibility    view = oacInheritFromTopBlock,
oaPlacementStatus    status = oacNonePlacementStatus
)  [static]
 

This function create an oaScalarInst object with the specified attributes. This function lets you specify the master design. A name for the new instance is automatically generated.

Parameters:
block The block in which to create the instance
master A pointer to the instance master
xform The transform for the instance
params Optional parameter array for pCell instances
view Specifies whether this instance is visible in the module domain
status Specifies the placement status of this instance
Exceptions:
oacInvalidSuperMaster 
oacParamsSuppliedForNonPCellInstMaster 

oaScalarInst * oaScalarInst::create (  oaBlock *    block,
oaDesign *    master,
const oaScalarName &    name,
const oaTransform &    xform,
const oaParamArray *    params = NULL,
oaBlockDomainVisibility    view = oacInheritFromTopBlock,
oaPlacementStatus    status = oacNonePlacementStatus
)  [static]
 

This function create an oaScalarInst object with the specified attributes. This function lets you specify the master design and name for the new instance. Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exist with the given name

Parameters:
block The block in which to create the instance
master A pointer to the instance master
name The instance name
xform The transform for the instance
params Optional parameter array for pCell instances
view Specifies whether this instance is visible in the module domain
status Specifies the placement status of this instance
Exceptions:
oacInvalidSuperMaster 
oacParamsSuppliedForNonPCellInstMaster 
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

oaScalarInst * oaScalarInst::find (  const oaBlock *    block,
const oaScalarName &    name
)  [static]
 

This function searches the specified design for a scalarInst with the specified name. If the name is found, the function returns the scalar instance. Otherwise, NULL is returned.

Returns:
The oaScalarInst pointer or NULL

void oaInst::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 oaInst::getName (  oaSimpleName &    name )  const
 

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

Parameters:
name The returned instance name

void oaScalarInst::getName (  oaScalarName &    name )  const
 

This function returns the name of this scalarInst in the name argument.

oaBoolean oaScalarInst::isValidName (  const oaBlock *    block,
const oaScalarName &    name
)  [static]
 

This function returns a boolean value that indicates if the specified name is valid for a new oaScalarInst in the specified block.

void oaScalarInst::setName (  const oaScalarName &    name ) 
 

This function changes the name of this instance to the specified name.

Exceptions are thrown if:

  • the new name does not imply a scalar name
  • an instance already exists with the given name
  • a vectorInstDef exists with the given name

Exceptions:
oacInvalidHierInstName 
oacInstNameExists 
oacInstNameOverlapsOtherInst 

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.