oaLayerArrayConstraintDef Class Reference

Inheritance diagram for oaLayerArrayConstraintDef:

oaConstraintDef oaSessionObject oaObject


Public Methods

oaUInt4 getNumLayers () const

Static Public Methods

oaLayerArrayConstraintDef * create (const oaString &name, const oaSubset< oaType > &allowedValues, const oaSubset< oaType > &allowedObjects, const oaSubset< oaDBType > &allowedDB, oaUInt4 numLayers)
oaLayerArrayConstraintDef * get (oaLayerArrayConstraintType type)

Detailed Description

An oaLayerArrayConstraintDef object specifies a definition for a constraint between three or more layers. 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, a list of objects to which a constraint based on this definition can be applied, and the number of layers for a constraint based on this definition. The names for constraint definitions must be unique.


Member Function Documentation

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

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

Parameters:
name The name of the layer array definition.
allowedValues The allowed types of oaValue sub classes.
allowedObjects The allowed objects a constraint of this def can be applied to.
allowedDB The types of databases a constraint based on this def can be created in.
numLayers The number of layers for a constraint of this def.

oaLayerArrayConstraintDef * oaLayerArrayConstraintDef::get oaLayerArrayConstraintType    type [static]
 

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

Parameters:
type An enum value that represents a built-in definition.

oaUInt4 oaLayerArrayConstraintDef::getNumLayers   const
 

This function returns the number of layers involved in the constraint definition.


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

Return to top of page