oaGroupDeleteWhen Class Reference


Public Methods

 oaGroupDeleteWhen (oaGroupDeleteWhenEnum valueIn)
 oaGroupDeleteWhen (const oaString &name)
 ~oaGroupDeleteWhen ()
const oaString & getName () const
 operator oaGroupDeleteWhenEnum () const

Detailed Description

The oaGroupDeleteWhen class is an enum wrapper that indicates the condition on which OpenAccess will automatically delete an oaGroup object. See oaGroup::setDeleteWhen for its usage. See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaGroupDeleteWhenEnum
 

Enumeration values:
oacNeverGroupDeleteWhen  "never" The group is never deleted automatically.
oacOnFirstGroupDeleteWhen  "onFirst" The group is deleted if any of its members are deleted.
oacOnLastGroupDeleteWhen  "onLast" The group is deleted if it becomes empty.

Constructor & Destructor Documentation

oaGroupDeleteWhen::oaGroupDeleteWhen (  oaGroupDeleteWhenEnum    valueIn )  [inline]
 

This function constructs an instance of an oaGroupDeleteWhen class using the specified oaGroupDeleteWhenEnum value.

oaGroupDeleteWhen::oaGroupDeleteWhen (  const oaString &    name ) 
 

This function constructs an instance of an oaGroupDeleteWhen class using the oaGroupDeleteWhenEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaGroupDeleteWhenEnum.

Exceptions:
oacInvalidGroupDeleteWhenTypeName 

oaGroupDeleteWhen::~oaGroupDeleteWhen (    )  [inline]
 

This group destroys this oaGroupDeleteWhen class.

Member Function Documentation

const oaString & oaGroupDeleteWhen::getName (    )  const
 

This function returns the name string associated with the encapsulated oaGroupDeleteWhenEnum object.

oaGroupDeleteWhen::operator oaGroupDeleteWhenEnum (    )  const [inline]
 

This operator casts this oaGroupDeleteWhen object into the corresponding oaGroupDeleteWhenEnum value.

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.