oaRouteStatus Class Reference

Public Methods
	oaRouteStatus (oaRouteStatusEnum valueIn)
	oaRouteStatus (const oaString &name)
	~oaRouteStatus ()
const oaString &	getName () const
	operator oaRouteStatusEnum () const

---

Detailed Description

The oaRouteStatus class encapsulates the enumerated values that describe the different routing status values

enum oaRouteStatusEnum

Enumeration values: oacNormalRouteStatus  "normal" This value indicates the normal routing status. oacFixedRouteStatus  "fixed" This value indicates the automatic tools should not edit this route but that this route can be hand-edited oacLockedRouteStatus  "locked" This value indicates this route should not be edited by hand or by the automatic tools; it is part of the base array

---

Constructor & Destructor Documentation

oaRouteStatus::oaRouteStatus (  oaRouteStatusEnum    valueIn )  [inline]

This function constructs an instance of an oaRouteStatus class using the specified oaRouteStatusEnum value.

oaRouteStatus::oaRouteStatus (  const oaString &    name )

This function constructs an instance of an oaRouteStatus class using the oaRouteStatusEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaRouteStatusEnum. Exceptions: oacInvalidRouteStatusTypeName

oaRouteStatus::~oaRouteStatus (    )  [inline]

This function destroys this oaRouteStatus class.

---

Member Function Documentation

const oaString & oaRouteStatus::getName (    )  const

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

oaRouteStatus::operator oaRouteStatusEnum (    )  const [inline]

This function casts this oaRouteStatus object into the corresponding oaRouteStatusEnum value.

---

The documentation for this class was generated from the following files:

• oaFig.h
• oaDesignEnumWrapper.inl
• oaRouteStatus.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.