oaConstraintGroupDef Class Reference

Inheritance diagram for oaConstraintGroupDef:

oaSessionObject oaObject


Public Methods

void destroy ()
void remove (oaObject *database)
void getName (oaString &name) const
oaConstraintGroupType getConstraintGroupType () const
oaBoolean isBuiltIn () const
oaBoolean isUniqueInDB () const
void getAllowedOwners (oaManagedTypeArray &allowedOwners) const
void getAllowedDatabases (oaSubset< oaDBType > &allowedDatabases) const

Static Public Methods

oaConstraintGroupDef * create (const oaString &name, const oaManagedTypeArray &allowedOwners, const oaSubset< oaDBType > &allowedDatabases, oaBoolean uniqueInDatabase=false)
oaConstraintGroupDef * find (const oaString &name)
oaConstraintGroupDef * get (oaConstraintGroupType type)

Public Types

enum  { dtIndex = oacBaseConstraintGroupDefDataType }

Detailed Description

This class specifies the semantics for constraint groups and defines how the constraints in the corresponding constraint groups are used. A constraint group definition contains a name and a list of oaManagedType types.

Refer to Using Constraint Group Definitions in the Creating and Modeling Process Rules and Constraints section of the Programmers Guide for information about OpenAccess built-in constraint group definitions.

Member Function Documentation

oaConstraintGroupDef * oaConstraintGroupDef::create (  const oaString &    name,
const oaManagedTypeArray &    allowedOwners,
const oaSubset< oaDBType > &    allowedDatabases,
oaBoolean    uniqueInDatabase = false
)  [static]
 

This function creates a new constraint group definition with the specified attributes. If the constraint group definition already exists, an exception is thrown.

Parameters:
name The name of the constraint group to create.
allowedOwners An array of the managed object types permitted in the associated constraint groups.
allowedDatabases The permitted types of databases in which a group specified with this definition can be created.
uniqueInDatabase If set to true, only one stand-alone constraintGroup of this type is permitted to be created in an allowed database.
Exceptions:
oacObjectDefExists 
oacInvalidConstraintGroupDefUniqueAttribute 
oacDBTypeCannotBeOwnerAndContainerConstraintGroupDef 

void oaConstraintGroupDef::destroy (    ) 
 

This function destroys this constraint group definition. If it is a built-in definition or there are databases referencing this definition, an exception is thrown. An exception is also thrown if this function is called when undo is enabled on any of the current in-memory design or tech databases.

Exceptions:
oacUnableToDestroyBuiltInType 
oacObjectDefHasReference 
oacCannotDestroyDefUndo 

oaConstraintGroupDef * oaConstraintGroupDef::find (  const oaString &    name )  [static]
 

This function returns the constraint group definition with the specified name. If no definition by that name is found, NULL is returned.

Parameters:
name The input name of the constraint group definition to match.

oaConstraintGroupDef * oaConstraintGroupDef::get (  oaConstraintGroupType    type )  [static]
 

This function returns the constraint group definition associated with the specified type.

Parameters:
type The input constraint group type of the constraint group definition to match.

void oaConstraintGroupDef::getAllowedDatabases (  oaSubset< oaDBType > &    allowedDatabases )  const
 

This method returns the valid types of databases in which a group specified with this definition can be created.

Parameters:
allowedDatabases the returned subset collection of allowed databases

void oaConstraintGroupDef::getAllowedOwners (  oaManagedTypeArray &    allowedOwners )  const
 

This function returns an array of objects that are allowed to own constraint groups of this type.

Parameters:
allowedOwners the returned managed type array of allowed owners.

oaConstraintGroupType oaConstraintGroupDef::getConstraintGroupType (    )  const
 

This function returns the type of this constraint group definition. This function throws an oacInvalidOperationOnUserDefinedConstraintGroupDef exception if the constraint group def is a user-defined constraint group def.

Exceptions:
oacInvalidOperationOnUserDefinedConstraintGroupDef 

void oaConstraintGroupDef::getName (  oaString &    name )  const
 

This function returns the name of this constraint group definition.

Parameters:
name returned name of this constraint group def

oaBoolean oaConstraintGroupDef::isBuiltIn (    )  const
 

This function returns true if the constraint group definition is a built-in definition.

oaBoolean oaConstraintGroupDef::isUniqueInDB (    )  const
 

This function returns true if only one stand-alone constraintGroup of this type can be created in the allowed databases

void oaConstraintGroupDef::remove (  oaObject *    database ) 
 

This function removes this constraint group definition from the specified database. If there are any constraint groups in the database that reference this definition, an oacObjectDefHasReference exception is thrown.

Parameters:
database The input database from which to remove this constraint group definition.
Exceptions:
oacObjectDefHasReference 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.