oaGroupDef Class Reference

Inheritance diagram for oaGroupDef:

oaSessionObject oaObject oaFlatGroupDef oaHierGroupDef


Public Methods

void getName (oaString &name) const
void getValidTypes (oaManagedTypeArray &validTypes) const
void getValidDatabases (oaSubset< oaDBType > &validDatabases) const
oaBoolean isBuiltIn () const
void destroy ()
void remove (oaObject *database)

Static Public Methods

oaGroupDef * find (const oaString &name)
oaGroupDef * get (oaGroupPurposeType groupDefType)

Public Types

enum  { dtIndex = oacBaseGroupDefDataType }

Detailed Description

This is a public managed class that specifies a definition for a group. The definition contains a name, a list of object types that can be placed in the group, and a list of databases by type in which the group can be created.

See Using Group Definitions in the Programmers Guide for more information.

Member Function Documentation

void oaGroupDef::destroy (    ) 
 

This function destroys this group definition. If it is a built-in definition or there are databases referencing this definition, an exception is thrown. If the group definition is a valid group definition in other hierarchical definitions, an exception is thrown as well. 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 

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

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

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

oaGroupDef * oaGroupDef::get (  oaGroupPurposeType    groupDefType )  [static]
 

This function returns the group definition with the specified group purpose type.

Parameters:
groupDefType The group purpose type to match.

void oaGroupDef::getName (  oaString &    name )  const
 

This function returns the name of this group definition.

Parameters:
name The returned name of this group definition.

void oaGroupDef::getValidDatabases (  oaSubset< oaDBType > &    validDatabases )  const
 

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

Parameters:
validDatabases The returned valid database types.

void oaGroupDef::getValidTypes (  oaManagedTypeArray &    validTypes )  const
 

This function returns the valid types of objects that can be added to a group with this definition.

Parameters:
validTypes The returned managed type array of valid names.

oaBoolean oaGroupDef::isBuiltIn (    )  const
 

This function returns true if this group def is a built-in def.

void oaGroupDef::remove (  oaObject *    database ) 
 

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

Parameters:
database The database in which the group definition is removed.
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.