oaInterpolateType Class Reference

Public Methods
	oaInterpolateType (oaInterpolateTypeEnum valueIn)
	oaInterpolateType (const oaString &nameIn)
	~oaInterpolateType ()
const oaString &	getName () const
	operator oaInterpolateTypeEnum () const

---

Detailed Description

The oaInterpolateType class is an enum wrapper that describes how keys in a lookup table should be interpolated if they lie between a pair of the header values for that table. See oa1DLookupTbl and oa2DLookupTbl for its usage. See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaInterpolateTypeEnum

Enumeration values: oacSnapDownInterpolateType  "SnapDown" Use the return value for the next lower header value oacSnapUpInterpolateType  "SnapUp" Use the return value for the next higher header value oacLinearInterpolateType  "Linear" Return a value that is between the return values for the next lower and the next higher header values in proportion to where the key is in that range. oacInclusiveSnapDownInterpolateType  "InclusiveSnapDown" Use the return value for the next lower header value, even if the requested value matches the higher header value. oacInclusiveSnapUpInterpolateType  "InclusiveSnapUp" Use the return value for the next higher header value, even if the requested value matches the lower header value.

---

Constructor & Destructor Documentation

oaInterpolateType::oaInterpolateType (  oaInterpolateTypeEnum    valueIn )  [inline]

This function constructs an instance of an oaInterpolateType class using the specified oaInterpolateTypeEnum value.

oaInterpolateType::oaInterpolateType (  const oaString &    name )

This function constructs an instance of an oaInterpolateType class using the oaInterpolateTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaInterpolateTypeEnum. Exceptions: oacInvalidInterpolateTypeName  This exception is thrown if no matching name is found

oaInterpolateType::~oaInterpolateType (    )  [inline]

This function destroys this oaInterpolateType class.

---

Member Function Documentation

const oaString & oaInterpolateType::getName (    )  const

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

oaInterpolateType::operator oaInterpolateTypeEnum (    )  const [inline]

This operator casts this oaInterpolateType object into the corresponding oaInterpolateTypeEnum value.

---

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

• oaLookupTbl.h
• oaLookupTbl.inl
• oaInterpolateType.dox

Return to top of page

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