oaDerivedLayerParamDef Class Reference

Inheritance diagram for oaDerivedLayerParamDef:

oaSessionObject oaObject


Public Methods

void getName (oaString &name) const
oaType getValueType () const
oaBoolean isBuiltIn () const
void destroy ()
void remove (oaTech *tech)

Static Public Methods

oaDerivedLayerParamDef * create (const oaString &name, oaType valueType)
oaDerivedLayerParamDef * get (oaDerivedLayerParamType type)
oaDerivedLayerParamDef * find (const oaString &name)

Detailed Description

The oaDerivedLayerParamDef object specifies a definition for a particular derived layer parameter. The definition contains a name and the valueType that is allowed for the parameter. The names for derived layer parameter definitions must be unique.

The oaDerivedLayer ParamDef class can be observed by deriving from oaObserver<oa DerivedLayer ParamDef>.

See Uniqueness of Session Objects for information about the requirement that session objects be unique.

Member Function Documentation

oaDerivedLayerParamDef * oaDerivedLayerParamDef::create (  const oaString &    name,
oaType    valueType
)  [static]
 

This function creates a new oaDerivedLayerParamDef. It is an error if the name of the derivedLayerParamDef already exists, and it is an error if the type specified is not an oaValue subtype.

Parameters:
name The constant oaString name for this oaDerivedLayerParamDef.
valueType An oaValue subtype.
Exceptions:
oacDerivedLayerParamDefExists 
oacInvalidValueType 

void oaDerivedLayerParamDef::destroy (    ) 
 

This function destroys the derivedLayerParamDef. If any database currently references this definition, or if this is a built-in 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 

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

This function finds the derived layer parameter definition by name. If the definition is not found, NULL is returned.

Parameters:
name The name of the derived layer parameter definition to find.

oaDerivedLayerParamDef * oaDerivedLayerParamDef::get (  oaDerivedLayerParamType    type )  [static]
 

This function returns the built in derived layer parameter definition of the type specified.

Parameters:
type An oaDerivedLayerParamType enum.

void oaDerivedLayerParamDef::getName (  oaString &    name )  const
 

This function returns the name of the derivedLayerParamDef.

Parameters:
name The constant oaString name of the oaDerivedLayerParamDef.

oaType oaDerivedLayerParamDef::getValueType (    )  const
 

This function returns the valueType of the derivedLayerParamDef.

oaBoolean oaDerivedLayerParamDef::isBuiltIn (    )  const
 

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

void oaDerivedLayerParamDef::remove (  oaTech *    tech ) 
 

This function removes the derivedLayerParamDef from the specified tech database. If there are derived layers in the database that reference this definition, an oacDerivedLayerParamDefHasReference exception is thrown.

Parameters:
tech The technology database containing the definition.
Exceptions:
oacDerivedLayerParamDefHasReference 

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.