oaConstraintParam Class Reference
Inheritance diagram for oaConstraintParam:
Detailed Description
The oaConstraintParam class represents a parameter used in creating constraint objects. Constraint parameters are defined by the constraintParamDef and have a value associated with them.
The oaConstraintParam class can be observed by deriving from oaObserver<oaConstraintParam>.
Member Function Documentation
| oaConstraintParam * oaConstraintParam::copy |
( |
|
) |
const |
|
|
|
This function copies this parameter and returns a pointer to the copy. |
| oaConstraintParam * oaConstraintParam::copyTo |
( |
oaObject * |
database |
) |
const |
|
|
|
This function copies this constraint parameter to the database specified. A pointer to the new constraint parameter is returned.
- Parameters:
-
| database | Database to copy parameter to |
- Exceptions:
-
|
|
|
This function creates a constraint parameter in the same database as the value specified.
- Parameters:
-
| def | The definition for the constraint parameter |
| value | The value for the parameter |
- Exceptions:
-
|
| void oaConstraintParam::destroy |
( |
|
) |
|
|
|
|
This function destroys this parameter and all of its associated values. If the parameter is owned by a constraint, an exception is thrown.
- Exceptions:
-
|
|
|
This function returns the definition for this constraint parameter. |
| oaValue * oaConstraintParam::getValue |
( |
|
) |
const |
|
|
|
This function returns the value for this constraint parameter. |
| oaBoolean oaConstraintParam::isOwned |
( |
|
) |
const |
|
|
|
This function returns the boolean indicating whether or not this parameter is owned by a constraint. |
| void oaConstraintParam::setValue |
( |
oaValue * |
value |
) |
|
|
|
|
This function sets the value for this constraint parameter.
- Parameters:
-
| value | The value to be set on this constraint parameter. |
- Exceptions:
-
|
Member Enumeration Documentation
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.
