oaLayerPairConstraintDef Class Reference

Inheritance diagram for oaLayerPairConstraintDef:

oaConstraintDef oaSessionObject oaObject


Public Methods

oaBoolean isSymmetric () const

Static Public Methods

oaLayerPairConstraintDef * create (const oaString &name, const oaSubset< oaType > &allowedValues, const oaSubset< oaType > &allowedObjects, const oaSubset< oaDBType > &allowedDB, oaBoolean symmetric=false)
oaLayerPairConstraintDef * get (oaLayerPairConstraintType type)

Detailed Description

An oaLayerPairConstraintDef object specifies a definition for a layer pair constraint. The definition contains a name, a list of databases that the constraint can be created in, a list of types of oaValues that are allowed for the constraint, and a boolean indicating whether or not the constraint is symmetric with respect to layer order. The names for constraint definitions must be unique.

Member Function Documentation

oaLayerPairConstraintDef * oaLayerPairConstraintDef::create (  const oaString &    name,
const oaSubset< oaType > &    allowedValues,
const oaSubset< oaType > &    allowedObjects,
const oaSubset< oaDBType > &    allowedDB,
oaBoolean    symmetric = false
)  [static]
 

This function creates a new layer pair constraint definition with the specified attributes.

Parameters:
name The name of the new definition.
allowedValues The value types that constraints with this definition can have.
allowedObjects The objects that constraints with this definition can be attached to.
allowedDB The databases that constraints with this definition can be created in.
symmetric A boolean indicating whether or not this definition is symmetric with respect to layer order.
Exceptions:
oacConstraintDefExists 
oacInvalidValueType 

oaLayerPairConstraintDef * oaLayerPairConstraintDef::get (  oaLayerPairConstraintType    type )  [static]
 

This function returns the built-in layer pair constraint definition of the type specified.

Parameters:
type The built in layer pair constraint type to get.

oaBoolean oaLayerPairConstraintDef::isSymmetric (    )  const
 

This function returns a boolean indicating whether this definition is symmetric with respect to layer order.

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.