oaClusterType Class Reference


Public Methods

 oaClusterType (oaClusterTypeEnum valueIn)
 oaClusterType (const oaString &name)
 ~oaClusterType ()
const oaString & getName () const
 operator oaClusterTypeEnum () const

Detailed Description

The oaClusterType class is an enum wrapper class that indicates the inclusiveness of an oaCluster's region.

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

enum oaClusterTypeEnum
 

Enumeration values:
oacClusterTypeInclusive  "inclusive" Instances other than the instance in this cluster may be placed in its region
oacClusterTypeExclusive  "exclusive" Only instances in this cluster may be placed in its region
oacClusterTypeSuggested  "suggested" Instances in this cluster may be placed outside of its region

Constructor & Destructor Documentation

oaClusterType::oaClusterType (  oaClusterTypeEnum    valueIn )  [inline]
 

This function constructs an instance of an oaClusterType class using the specified oaClusterTypeEnum value.

oaClusterType::oaClusterType (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidClusterTypeName 

oaClusterType::~oaClusterType (    )  [inline]
 

This function destroys this oaClusterType object.

Member Function Documentation

const oaString & oaClusterType::getName (    )  const
 

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

oaClusterType::operator oaClusterTypeEnum (    )  const [inline]
 

This operator casts this oaClusterType object into the corresponding oaClusterTypeEnum 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.