oaSymmetry Class Reference


Public Methods

 oaSymmetry (oaSymmetryEnum valueIn)
 oaSymmetry (const oaString &name)
 ~oaSymmetry ()
const oaString & getName () const
 operator oaSymmetryEnum () const

Detailed Description

The oaSymmetry class encapsulates the enumerated values that describe the different symmetries of an oaDesign object.

enum oaSymmetryEnum
 

Enumeration values:
oacNoSymmetry  "none"
oacXSymmetry  "x"
oacYSymmetry  "y"
oacXYSymmetry  "xy"
oacAnySymmetry  "any"

Constructor & Destructor Documentation

oaSymmetry::oaSymmetry (  oaSymmetryEnum    valueIn )  [inline]
 

This function constructs an instance of an oaSymmetry class using the specified enum value. The enum values are defined in oaSymmetryEnum.

oaSymmetry::oaSymmetry (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidSymmetryName 

oaSymmetry::~oaSymmetry (    )  [inline]
 

This function destroys this oaSymmetry object, removing it from the database.

Member Function Documentation

const oaString & oaSymmetry::getName (    )  const
 

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

oaSymmetry::operator oaSymmetryEnum (    )  const [inline]
 

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