oaConstraintGroupMem Class Reference

Inheritance diagram for oaConstraintGroupMem:

oaObject


Public Methods

void destroy ()
oaConstraintGroup * getConstraintGroup () const
oaObject * getObject () const
oaBoolean isImplicit () const
void moveAfter (oaConstraintGroupMem *member)
void moveToFirst ()

Static Public Methods

oaConstraintGroupMem * create (oaConstraintGroup *group, oaConstraint *constraint, oaBoolean prepend=false)
oaConstraintGroupMem * create (oaConstraintGroup *group, oaConstraintGroup *groupMem, oaBoolean prepend=false)

Public Types

enum  { dtIndex = oacBaseConstraintGroupMemDataType }

Detailed Description

The oaConstraintGroupMem class implements the members of a constraint group. A constraint group member can be an individual constraint, or another constraint group.

A collection of all the oaConstraintGroupMems in a parent constraint group is returned by oaConstraintGroup::getMembers.

An instance of oaConstraintGroupMem is automatically destroyed when either the object it references or the parent constraint group is destroyed.

The oaConstraintGroupMem class can be observed by deriving from oaObserver<oaConstraintGroupMem>.

Member Function Documentation

oaConstraintGroupMem * oaConstraintGroupMem::create (  oaConstraintGroup *    group,
oaConstraintGroup *    groupMem,
oaBoolean    prepend = false
)  [static]
 

This function creates a constraint group member that is itself a constraint group.

Typically, the constraint group and the parent constraint group are in the same database, or if the parent constraint group is in the design database, the member may be in the technology database.

A parent constraint group can also include a member that is a user-defined constraint group in a referenced technology database. For more information about referenced technology databases, see Using Technology Databases in the Programmers Guide.

By default constraint group members are appended to the constraint group.

Parameters:
group The constraint group to which this member is to be added.
groupMem The constraint group to include in the specified group.
prepend A boolean indicating whether to add this member as the first member of the constraint group.
Exceptions:
oacConstraintGroupMemberNotInValidDB 
oacConstraintGroupAlreadyHasObj 

oaConstraintGroupMem * oaConstraintGroupMem::create (  oaConstraintGroup *    group,
oaConstraint *    constraint,
oaBoolean    prepend = false
)  [static]
 

This function creates a constraint group member that is an individual constraint. The constraint and the parent constraint group must be in the same database. By default constraint group members are appended to the constraint group.

Parameters:
group The constraint group to which this member is to be added.
constraint The constraint to include in the specified group.
prepend A boolean indicating whether to add this member as the first member of the constraint group.
Exceptions:
oacConstraintGroupMemberNotInValidDB 
oacConstraintGroupAlreadyHasObj 

void oaConstraintGroupMem::destroy (    ) 
 

This function destroys the constraint group member specified, removing it from the parent constraint group. The associated object is not destroyed.

oaConstraintGroup * oaConstraintGroupMem::getConstraintGroup (    )  const
 

This function returns the parent constraint group for this group member.

Reimplemented from oaObject.

oaObject * oaConstraintGroupMem::getObject (    )  const
 

This function returns the object (constraint, constraint group or constraint group header) that is referred by this constraint group member. Objects that refer to constraint groups in a different database will be returned as oaConstraintGroupHeader objects.

oaBoolean oaConstraintGroupMem::isImplicit (    )  const
 

This function returns a boolean indicating whether the constraint group member was implicitly created by the database. The database creates implicit members for constraint groups such as the foundry constraint group or the default constraint group for incremental technology databases.

It is an error to attempt to move or destroy an implicit constraint group member.

For more information about incremental technology databases, refer to Using Technology Databases in the Programmers Guide.

void oaConstraintGroupMem::moveAfter (  oaConstraintGroupMem *    member ) 
 

This function moves this constraint group member to the position after the specified member in the same constraint group.

Parameters:
member The constraint group member to move this member after.
Exceptions:
oacInvalidConstraintGroupForMemberMove 

void oaConstraintGroupMem::moveToFirst (    ) 
 

This function attempts to move this constraint group member to the first member in its group. The current first constraint group member is moved to the second, and subsequent members are also move down in order.

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.