oaLayerConstraintDef Class Reference

Inheritance diagram for oaLayerConstraintDef:

oaConstraintDef oaSessionObject oaObject


Static Public Methods

oaLayerConstraintDef * create (const oaString &name, const oaSubset< oaType > &allowedValues, const oaSubset< oaType > &allowedObjects, const oaSubset< oaDBType > &allowedDB)
oaLayerConstraintDef * get (oaLayerConstraintType type)

Detailed Description

A oaLayerConstraintDef object specifies a definition for a layer constraint. The definition contains a name, a list of databases that the constraint can be created in, and a list of types of oaValues that are allowed for the constraint. The names for all constraint definitions must be unique.


Member Function Documentation

oaLayerConstraintDef * oaLayerConstraintDef::create const oaString &    name,
const oaSubset< oaType > &    allowedValues,
const oaSubset< oaType > &    allowedObjects,
const oaSubset< oaDBType > &    allowedDB
[static]
 

This function creates a new layer 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.
Exceptions:
oacConstraintDefExists 
oacInvalidValueType 

oaLayerConstraintDef * oaLayerConstraintDef::get oaLayerConstraintType    type [static]
 

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

Parameters:
type The built-in layer constraint type to find.


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

Return to top of page