oaGroupPurposeType Class Reference


Public Methods

 oaGroupPurposeType (oaGroupPurposeTypeEnum valueIn)
 oaGroupPurposeType (const oaString &name)
const oaString & getName () const
 operator oaGroupPurposeTypeEnum () const

Detailed Description

The oaGroupPurposeType class is an enum wrapper class for oaGroupPurposeTypeEnum values.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaGroupPurposeTypeEnum
 

Enumeration values:
oacUnrestrictedGroupPurposeType  "oaUnrestricted"
oacDiffNetPairGroupPurposeType  "oaDiffNetPair"
oacMatchedNetGroupPurposeType  "oaMatchedNet"
oacNetGroupPurposeType  "oaNet"
oacNestedNetGroupPurposeType  "oaNestedNet"
oacSymmetricNetGroupPurposeType  "oaSymmetricNet"

Constructor & Destructor Documentation

oaGroupPurposeType::oaGroupPurposeType (  oaGroupPurposeTypeEnum    valueIn )  [inline]
 

This constructor for the oaGroupPurposeType class takes an oaGroupPurposeTypeEnum value.

Parameters:
valueIn An oaGroupPurposeTypeEnum value.

oaGroupPurposeType::oaGroupPurposeType (  const oaString &    name ) 
 

This function creates an instance of an oaGroupPurposeType object using the oaGroupPurposeTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with an oaGroupPurposeTypeEnum.

Parameters:
name The name of the group purpose type enum.
Exceptions:
oacInvalidGroupDefTypeName 

Member Function Documentation

const oaString & oaGroupPurposeType::getName (    )  const
 

This function returns the name associated with the encapsulated oaGroupPurposeTypeEnum object.

oaGroupPurposeType::operator oaGroupPurposeTypeEnum (    )  const [inline]
 

This operator casts this oaGroupPurposeType object into the corresponding oaGroupPurposeTypeEnum.

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.