oaPrefRoutingDir Class Reference


Public Methods

 oaPrefRoutingDir (oaPrefRoutingDirEnum valueIn)
 oaPrefRoutingDir (const oaString &name)
 ~oaPrefRoutingDir ()
const oaString & getName () const
 operator oaPrefRoutingDirEnum () const

Detailed Description

The oaPrefRoutingDir class encapsulates the enumerated values that describe the different preferred routing directions.

enum oaPrefRoutingDirEnum
 

Enumeration values:
oacNotApplicablePrefRoutingDir  "notApplicable"
oacNonePrefRoutingDir  "none"
oacHorzPrefRoutingDir  "horizontal"
oacVertPrefRoutingDir  "vertical"
oacLeftDiagPrefRoutingDir  "leftDiag"
oacRightDiagPrefRoutingDir  "rightDiag"

Constructor & Destructor Documentation

oaPrefRoutingDir::oaPrefRoutingDir (  oaPrefRoutingDirEnum    valueIn )  [inline]
 

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

oaPrefRoutingDir::oaPrefRoutingDir (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidPrefRoutingDirName 

oaPrefRoutingDir::~oaPrefRoutingDir (    )  [inline]
 

This function destroys this oaPrefRoutingDir instance.

Member Function Documentation

const oaString & oaPrefRoutingDir::getName (    )  const
 

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

oaPrefRoutingDir::operator oaPrefRoutingDirEnum (    )  const [inline]
 

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