oaLayerArrayConstraint Class Reference

Inheritance diagram for oaLayerArrayConstraint:

Public Methods
void	getLayers (oaLayerArray &layerNums) const
void	getPurposes (oaPurposeArray &purposeNums) const
Static Public Methods
oaLayerArrayConstraint *	create (const oaLayerArray &layerNums, const oaLayerArrayConstraintDef *def, oaValue *value, oaBoolean isHard=true, const oaConstraintParamArray *params=NULL)
oaLayerArrayConstraint *	create (const oaLayerArray &layerNums, const oaLayerArrayConstraintDef *def, const oaString &name, oaValue *value, oaBoolean isHard=true, const oaConstraintParamArray *params=NULL)
oaLayerArrayConstraint *	create (const oaLayerArray &layerNums, const oaPurposeArray &purposeNums, const oaLayerArrayConstraintDef *def, oaValue *value, oaBoolean isHard=true, const oaConstraintParamArray *params=NULL)
oaLayerArrayConstraint *	create (const oaLayerArray &layerNums, const oaPurposeArray &purposeNums, const oaLayerArrayConstraintDef *def, const oaString &name, oaValue *value, oaBoolean isHard=true, const oaConstraintParamArray *params=NULL)
oaLayerArrayConstraint *	find (const oaConstraintGroup *group, const oaLayerArray &layerNums, const oaLayerArrayConstraintDef *def, oaBoolean hardOnly=false)
oaLayerArrayConstraint *	find (const oaConstraintGroup *group, const oaLayerArray &layerNums, const oaPurposeArray &purposeNums, const oaLayerArrayConstraintDef *def, oaBoolean hardOnly=false)
oaCollection< oaLayerArrayConstraint, oaConstraintGroup >	getConstraints (const oaConstraintGroup *group, const oaLayerArray &layerNums, const oaLayerArrayConstraintDef *def=NULL)

---

Detailed Description

This class represents a constraint object that constrains interactions between more than two layers. Full description of oaLayerArrayConstraint includes the following:

• An array of layers (oaLayerArray)
• The constraint definition (oaLayerArrayConstraintDef)
• The constraint name (oaString). When creating an oaLayerArrayConstraint, providing the name is optional. If the name is not specified, the new constraint is auto-named by OpenAccess.
• The constraint value (oaValue). oaLayerArrayConstraint must be created in the same database as that value.
• A boolean attribute (oaBoolean) indicating whether the constraint is hard, which means it must be met, or soft.
• An optional list of constraint parameters (oaConstraintParamArray).

oaLayerArrayConstraints get applied to objects by being placed in an oaConstraintGroup.

---

Member Function Documentation

oaLayerArrayConstraint * oaLayerArrayConstraint::create (  const oaLayerArray &    layerNums, const oaPurposeArray &    purposeNums, const oaLayerArrayConstraintDef *    def, const oaString &    name, oaValue *    value, oaBoolean    isHard = true, const oaConstraintParamArray *    params = NULL )  [static]

This function creates an explicitly named constraint. The new layer array constraint is created in the same database as the value specified and with the specified purpose. Parameters: layerNums  The array of layer numbers that this constraint applies to. purposeNums  The list of purpose numbers for this constraint def  The definition for this constraint. name  The name of this constraint. value  The constraint value. isHard  A boolean indicating whether this constraint must be met. params  The parameters associated with this constraint. Exceptions: oacValueAlreadyOwned  oacInvalidDatabaseForLayerArrayConstraint  oacConstraintParamAlreadyOwned  oacConstraintParamNotInSameDB  oacInvalidValueForConstraintDef  oacInvalidDBForConstraintDef  oacInvalidLayerArrayForLayerArrayConstraint  oacInvalidPurposeArrayForLayerArrayConstraint  oacConstraintNameExists  oacInvalidBasePurposeNumber

oaLayerArrayConstraint * oaLayerArrayConstraint::create (  const oaLayerArray &    layerNums, const oaPurposeArray &    purposeNums, const oaLayerArrayConstraintDef *    def, oaValue *    value, oaBoolean    isHard = true, const oaConstraintParamArray *    params = NULL )  [static]

This function creates an auto-named constraint. The new layer array constraint is created in the same database as the value specified and with the specified purpose. Parameters: layerNums  The array of layer numbers that this constraint applies to. purposeNums  The list of purpose numbers for this constraint def  The definition for this constraint. value  The constraint value. isHard  A boolean indicating whether this constraint must be met. params  The parameters associated with this constraint. Exceptions: oacValueAlreadyOwned  oacInvalidDatabaseForLayerArrayConstraint  oacConstraintParamAlreadyOwned  oacConstraintParamNotInSameDB  oacInvalidValueForConstraintDef  oacInvalidDBForConstraintDef  oacInvalidLayerArrayForLayerArrayConstraint  oacInvalidPurposeArrayForLayerArrayConstraint  oacInvalidBasePurposeNumber

oaLayerArrayConstraint * oaLayerArrayConstraint::create (  const oaLayerArray &    layerNums, const oaLayerArrayConstraintDef *    def, const oaString &    name, oaValue *    value, oaBoolean    isHard = true, const oaConstraintParamArray *    params = NULL )  [static]

This function creates a new layer array constraint with the specified name in the same database as the specified value. Parameters: layerNums  The array of layer numbers that this constraint applies to. def  The definition for this constraint. name  The name of this constraint. value  The constraint value. isHard  A boolean indicating whether this constraint must be met. params  The parameters associated with this constraint. Exceptions: oacValueAlreadyOwned  oacInvalidDatabaseForLayerArrayConstraint  oacConstraintNameExists

oaLayerArrayConstraint * oaLayerArrayConstraint::create (  const oaLayerArray &    layerNums, const oaLayerArrayConstraintDef *    def, oaValue *    value, oaBoolean    isHard = true, const oaConstraintParamArray *    params = NULL )  [static]

This function creates a new, auto-named layer array constraint in the same database as the specified value. Parameters: layerNums  The array of layer numbers that this constraint applies to. def  The definition for this constraint. value  The constraint value. isHard  A boolean indicating whether this constraint must be met. params  The parameters associated with this constraint. Exceptions: oacValueAlreadyOwned  oacInvalidDatabaseForLayerArrayConstraint

oaLayerArrayConstraint * oaLayerArrayConstraint::find (  const oaConstraintGroup *    group, const oaLayerArray &    layerNums, const oaPurposeArray &    purposeNums, const oaLayerArrayConstraintDef *    def, oaBoolean    hardOnly = false )  [static]

This function returns the first constraint in this group that matches the definition, layers, purposes, and isHard attribute specified. If no such constraint is found NULL is returned. oavPurposeNumberAny acts as a wildcard and selects any purpose number. If the purpose number array includes oavPurposeNumberAny, the returned constraint must have the other purposes explicitly specified in the array plus any other purpose. Parameters: group  The constraint group in which to locate the constraint. layerNums  The layer numbers to match. purposeNums  The purpose numbers to match. def  The layer definition. hardOnly  A boolean indicating whether the constraint to match is hard or soft.

oaLayerArrayConstraint * oaLayerArrayConstraint::find (  const oaConstraintGroup *    group, const oaLayerArray &    layerNums, const oaLayerArrayConstraintDef *    def, oaBoolean    hardOnly = false )  [static]

This function returns the first constraint in this group that matches the specified definition, layers and isHard attribute. If no such constraint is found, NULL is returned. Parameters: group  The constraint group in which to locate the constraint. layerNums  The layer numbers to match. def  The layer definition. hardOnly  A boolean indicating a hard or soft constraint.

oaLayerArrayConstraint::getConstraints (  const oaConstraintGroup *    group, const oaLayerArray &    layerNums, const oaLayerArrayConstraintDef *    def = NULL )  [static]

This function returns a collection of layer array constraints, with the specified definition, and based on the specified layers, in the specified group. If no definition is specified, all layer array constraints on the specified layers in the group are returned. Parameters: group  The constraint group that the collection belongs to. layerNums  The layer numbers of the constraint to match. def  An optional layer array constraint definition to match.

void oaLayerArrayConstraint::getLayers (  oaLayerArray &    layerNums )  const

This function returns the layer numbers associated with this layer array constraint. The function fills the layer array provided by the caller. All layer numbers that existed in the layer array before the call are removed from the array, so that after the function returns, the layerNums array contains only the layers on which the constraint depends. Parameters: layerNums  The layer numbers of the constraint.

void oaLayerArrayConstraint::getPurposes (  oaPurposeArray &    purposeNums )  const

This function returns the purpose numbers associated with this layer constraint and fills the purposeNums array provided by the caller. Any purpose numbers that exist in the array before the call are removed. After the function returns, the purposeNums array contains only the purpose numbers on which the constraint depends. Parameters: purposeNums  The returned array of purpose numbers for this constraint.

---

The documentation for this class was generated from the following files:

• oaLayerArrayConstraint.h
• oaLayerArrayConstraint.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.