oaHierGroupDef Class Reference

Inheritance diagram for oaHierGroupDef:

oaGroupDef oaSessionObject oaObject


Public Methods

oaBoolean isRecursive () const
void getValidGroupTypes (oaGroupDefArray &validGroupTypes) const

Static Public Methods

oaHierGroupDef * create (const oaString &name, const oaManagedTypeArray &validTypes, const oaSubset< oaDBType > &validDatabases)
oaHierGroupDef * create (const oaString &name, const oaManagedTypeArray &validTypes, const oaSubset< oaDBType > &validDatabases, const oaGroupDefArray &validGroupTypes, oaBoolean recursive=false)

Detailed Description

This class defines a group that permits other (nested) groups as members. The nested groups can be the same type or different. The oaGroupDefArray is used to create a list of group definitions for the group types that can be members of a group defined as an oaHierGroupDef type.

Member Function Documentation

oaHierGroupDef * oaHierGroupDef::create (  const oaString &    name,
const oaManagedTypeArray &    validTypes,
const oaSubset< oaDBType > &    validDatabases,
const oaGroupDefArray &    validGroupTypes,
oaBoolean    recursive = false
)  [static]
 

This function creates a new hierarchical group definition with the specified attributes.

Parameters:
name The name of this group definition.
validTypes The valid managed object types for this group definition.
validDatabases The databases that a group with this definition can exist in.
validGroupTypes The types of nested groups permitted by this definition.
recursive If true, permits nested group members to be associated with this same definition.
Exceptions:
oacObjectDefExists 

oaHierGroupDef * oaHierGroupDef::create (  const oaString &    name,
const oaManagedTypeArray &    validTypes,
const oaSubset< oaDBType > &    validDatabases
)  [static]
 

This function creates a new hierarchical group definition with the specified attributes. All groups are valid members of groups that are associated with this definiton.

Parameters:
name The name of this group definition.
validTypes The valid managed object types for this group definition.
validDatabases The databases that a group with this definition can exist in.
Exceptions:
oacObjectDefExists 

void oaHierGroupDef::getValidGroupTypes (  oaGroupDefArray &    validGroupTypes )  const
 

This function returns the set of valid group types associated with this definition in the specified oaGroupDefArray. An empty array implies that all group types are valid.

Parameters:
validGroupTypes An array of the returned valid group types associated with this definition.

oaBoolean oaHierGroupDef::isRecursive (    )  const
 

This function returns true if groups associated with this definition can include other groups that also are associated with this definition.

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.