oaPurposeType Class Reference


Public Methods

 oaPurposeType (oaPurposeTypeEnum valueIn)
 oaPurposeType (const oaString &name)
 ~oaPurposeType ()
const oaString & getName () const
 operator oaPurposeTypeEnum () const

Static Public Methods

oaPurposeTypeEnum get (oaPurposeNum purposeNum)

Detailed Description

The oaPurposeType class encapsulates the enumerated values that describe the different uses of an oaPurpose object.

enum oaPurposeTypeEnum
 

Enumeration values:
oacDrawingPurposeType  "drawing"
oacFillPurposeType  "fill"
oacSlotPurposeType  "slot"
oacOPCSerifPurposeType  "OPCSerif"
oacOPCAntiSerifPurposeType  "OPCAntiSerif"
oacAnnotationPurposeType  "annotation"
oacGapFillPurposeType  "gapFill"
oacRedundantPurposeType  "redundant"
oacAnyPurposeType  "oaAny"
oacNoPurposeType  "oaNo"
oacFillOPCPurposeType  "oaFillOPC"

Constructor & Destructor Documentation

oaPurposeType::oaPurposeType (  oaPurposeTypeEnum    valueIn ) 
 

This function constructs an instance of an oaPurposeType class using the specified oaPurposeTypeEnum value.

Parameters:
valueIn A value from the enumerated list representing purpose types that this object will represent

oaPurposeType::oaPurposeType (  const oaString &    name ) 
 

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

Parameters:
name A reference to an oaString object representing a valid purpose type name
Exceptions:
oacInvalidPurposeTypeName 

oaPurposeType::~oaPurposeType (    )  [inline]
 

This function destroys this oaPurpose object.

Member Function Documentation

oaPurposeTypeEnum oaPurposeType::get (  oaPurposeNum    purposeNum )  [inline, static]
 

This utility function converts a purposeNum to a purposeType.

Parameters:
purposeNum input purpose number

const oaString & oaPurposeType::getName (    )  const
 

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

oaPurposeType::operator oaPurposeTypeEnum (    )  const [inline]
 

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