oaPlacementStatus Class Reference

Public Methods
	oaPlacementStatus (oaPlacementStatusEnum valueIn)
	oaPlacementStatus (const oaString &name)
	~oaPlacementStatus ()
const oaString &	getName () const
	operator oaPlacementStatusEnum () const

---

Detailed Description

The oaPlacementStatus class encapsulates the enumerated values that describe the different placement status you can assign to an instance or a pin.

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

enum oaPlacementStatusEnum

Enumeration values: oacNonePlacementStatus  "none" The placement status has not been set, but the current placement location is to be treated as valid oacUnplacedPlacementStatus  "unplaced" The current placement is arbitrary and should be changed. Unplaced objects do not contribute to the bounding box of the containing design, and they will not be returned by region query. oacPlacedPlacementStatus  "placed" An effort has been made to place this object but it may be placed again by future attempts oacFixedPlacementStatus  "fixed" The placement of this object should not be changed by an automatic placement tool oacLockedPlacementStatus  "locked" The placement of this object should not be changed

---

Constructor & Destructor Documentation

oaPlacementStatus::oaPlacementStatus (  oaPlacementStatusEnum    valueIn )  [inline]

This function constructs an instance of an oaPlacementStatus class using the specified oaPlacementStatusEnum value. Parameters: valueIn  an oaPlacementStatusEnum value

oaPlacementStatus::oaPlacementStatus (  const oaString &    name )

This function constructs an instance of an oaPlacementStatus class using the oaPlacementStatusEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaPlacementStatusEnum. Parameters: name  an oaPlacementStatusEnum string name Exceptions: oacInvalidPlacementStatusTypeName

oaPlacementStatus::~oaPlacementStatus (    )  [inline]

This function destroys this oaPlacementStatus class.

---

Member Function Documentation

const oaString & oaPlacementStatus::getName (    )  const

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

oaPlacementStatus::operator oaPlacementStatusEnum (    )  const [inline]

This operator casts this oaPlacementStatus object into the corresponding oaPlacementStatusEnum.

---

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

• oaInst.h
• oaDesignEnumWrapper.inl
• oaPlacementStatus.dox

Return to top of page

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