oaDerivedLayerParam Class Reference

Inheritance diagram for oaDerivedLayerParam:

oaTechObject oaObject


Public Methods

void destroy ()
oaValue * getValue () const
oaDerivedLayerParamDef * getDef () const
oaBoolean isOwned () const
void setValue (oaValue *value)
oaDerivedLayerParam * copy () const
oaDerivedLayerParam * copyTo (oaObject *database) const

Static Public Methods

oaDerivedLayerParam * create (const oaDerivedLayerParamDef *def, oaValue *value)

Public Types

enum  { dtIndex = oacTechDerivedLayerParamDataType }

Detailed Description

This class creates the parameters associated with a derived layer.

Member Function Documentation

oaDerivedLayerParam * oaDerivedLayerParam::copy (    )  const
 

This function copies this parameter and returns a pointer to the copy.

oaDerivedLayerParam * oaDerivedLayerParam::copyTo (  oaObject *    database )  const
 

This function copies this derived layer parameter to the specified database. A pointer to the new derived layer parameter is returned.

Parameters:
database A pointer to the database in which to place the copy of the derived layer parameter.
Exceptions:
oacValueInvalidForDerivedLayerParamDef 

oaDerivedLayerParam * oaDerivedLayerParam::create (  const oaDerivedLayerParamDef *    def,
oaValue *    value
)  [static]
 

This function creates a derived layer parameter in the same database as the specified value.

Parameters:
def A pointer to the derived layer parameter definition.
value A pointer to the value in the database in which to create the derived layer parameter.
Exceptions:
oacValueAlreadyOwned 
oacValueInvalidForDerivedLayerParamDef 

void oaDerivedLayerParam::destroy (    ) 
 

This function destroys this parameter, and all of its associated values. If the parameter is owned by a derived layer, an error is thrown.

Exceptions:
oacCantDestroyOwnedDerivedLayerParam 

oaDerivedLayerParamDef * oaDerivedLayerParam::getDef (    )  const
 

This function returns the definition for this derived layer parameter.

oaValue * oaDerivedLayerParam::getValue (    )  const
 

This function returns the value for this derived layer parameter.

oaBoolean oaDerivedLayerParam::isOwned (    )  const
 

This function returns a boolean indicating whether this parameter is owned by a derived layer.

void oaDerivedLayerParam::setValue (  oaValue *    value ) 
 

This function sets the value for this derived layer parameter.

Parameters:
value A pointer to the value to set on this derived layer parameter.
Exceptions:
oacValueAlreadyOwned 
oacValueNotInSameDatabase 
oacValueInvalidForDerivedLayerParamDef 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.