oaConstraintGroupHeader Class Reference

Inheritance diagram for oaConstraintGroupHeader:

oaObject


Public Methods

oaConstraintGroup * getConstraintGroup () const
void getName (oaString &name) const
oaCollection< oaConstraintGroupMem, oaConstraintGroupHeader > getConstraintGroupMems () const
oaBoolean isBound () const

Static Public Methods

oaConstraintGroupHeader * find (const oaObject *database, const oaString &name)

Public Types

enum  { dtIndex = oacBaseConstraintGroupHeaderDataType }

Detailed Description

The oaConstraintGroupHeader class implements persistent objects that are created and destroyed automatically on an as needed basis. The existence of an oaConstraintGroupHeader object indicates that the constraint group it represents is currently being used by a database object in some way in the design hierarchy.

oaConstraintGroupHeader objects provide direct access to the collections of constraint group members that use the constraint group they represent.

Member Function Documentation

oaConstraintGroupHeader * oaConstraintGroupHeader::find (  const oaObject *    database,
const oaString &    name
)  [static]
 

This function searches the specified database looking for a ConstraintGroupHeader with the specified constraint group name. If the ConstraintGroupHeader is found, it is returned, otherwise NULL is returned. NULL is always returned if the specified constraint group name is default or foundry.

Parameters:
database Database to search in
name Name of constraint group to search for
Exceptions:
oacInvalidDatabase 

oaConstraintGroup * oaConstraintGroupHeader::getConstraintGroup (    )  const
 

This function attempts to return the constraintGroup associated with the specified ConstraintGroupHeader. If the ConstraintGroupHeader cannot be bound NULL will be returned.

Reimplemented from oaObject.

oaCollection< oaConstraintGroupMem, oaConstraintGroupHeader > oaConstraintGroupHeader::getConstraintGroupMems (    )  const
 

This function returns a collection of all of the constraint group members that reference this constraint group header.

void oaConstraintGroupHeader::getName (  oaString &    name )  const
 

This function returns the name associated with constraint group represented by this ConstraintGroupHeader.

Parameters:
name String to return name in

oaBoolean oaConstraintGroupHeader::isBound (    )  const
 

This function returns a boolean indicating whether or not this ConstraintGroupHeader is bound to its associated constraint group object.

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.