oaDerivedLayerDef Class Reference

Inheritance diagram for oaDerivedLayerDef:

oaSessionObject oaObject


Public Methods

void getName (oaString &name) const
oaUInt4 getNumLayers () const
oaBoolean isBuiltIn () const
void destroy ()
void remove (oaTech *tech)

Static Public Methods

oaDerivedLayerDef * create (const oaString &name, oaUInt4 numLayers)
oaDerivedLayerDef * get (oaLayerOp type)
oaDerivedLayerDef * find (const oaString &name)

Detailed Description

This class determines the number of parent layers for the corresponding derived layer. For each of the oaLayerOpEnum items, except oacUserDefinedLayerOp, there is a built-in oaDerivedLayerDef object. oacUserDefinedLayerOp is the oaLayerOpEnum value for any user-defined derived layer.

Member Function Documentation

oaDerivedLayerDef * oaDerivedLayerDef::create (  const oaString &    name,
oaUInt4    numLayers
)  [static]
 

This function creates a new, user-defined layer definition.

Parameters:
name 
numLayers 
Exceptions:
oacDerivedLayerDefExists 

void oaDerivedLayerDef::destroy (    ) 
 

This function destroys this oaDerivedLayerDef object. If it is a built-in definition, or there are databases referencing this definition, an exception is thrown. An exception is also thrown if this function is called when undo is enabled on any of the current in-memory design or tech databases.

Exceptions:
oacUnableToDestroyBuiltInType 
oacDerivedLayerParamDefHasReference 
oacCannotDestroyDefUndo 

oaDerivedLayerDef * oaDerivedLayerDef::find (  const oaString &    name )  [static]
 

This function returns the derived layer definition with the name specified. If no definition by that name is found, NULL is returned.

Parameters:
name The string name of the derived layer to find.

oaDerivedLayerDef * oaDerivedLayerDef::get (  oaLayerOp    type )  [static]
 

This function returns the built-in layer definitions for the specified oaLayerOp object.

Parameters:
type The type of the layer operation.

void oaDerivedLayerDef::getName (  oaString &    name )  const
 

This function returns the name of this derived layer definition.

Parameters:
name A reference to the string name of this derived layer definition.

oaUInt4 oaDerivedLayerDef::getNumLayers (    )  const
 

This function returns the number of input layers for a derived layer specified with this definiion.

oaBoolean oaDerivedLayerDef::isBuiltIn (    )  const
 

This function returns true if this derived layer def is a built-in def.

void oaDerivedLayerDef::remove (  oaTech *    tech ) 
 

This function removes this derived layer definition from the specified database. All derived layers are destroyed in the database that references this definition.

Parameters:
tech The technology database containing the derived layer definition.

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.