oaExtrapolateType Class Reference


Public Methods

 oaExtrapolateType (oaExtrapolateTypeEnum valueIn)
 oaExtrapolateType (const oaString &nameIn)
 ~oaExtrapolateType ()
const oaString & getName () const
 operator oaExtrapolateTypeEnum () const

Detailed Description

The oaExtrapolateType class is an enum wrapper that describes how keys in a lookup table should be extrapolated if they lie outside of the range of 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 oaExtrapolateTypeEnum
 

Enumeration values:
oacSnapDownExtrapolateType  "SnapDown" If the key is greater than the highest header value, then use the table entry for the highest header value.
oacSnapUpExtrapolateType  "SnapUp" If the key is smaller than the lowest header value, then use the table entry for the lowest header value.
oacLinearExtrapolateType  "Linear" Extrapolate from the two points at the end (either lower or upper) to the key value.

Constructor & Destructor Documentation

oaExtrapolateType::oaExtrapolateType (  oaExtrapolateTypeEnum    valueIn )  [inline]
 

This function constructs an instance of an oaExtrapolateType class using the specified oaExtrapolateTypeEnum value.

oaExtrapolateType::oaExtrapolateType (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidExtrapolateTypeName This exception is thrown if no matching name is found

oaExtrapolateType::~oaExtrapolateType (    )  [inline]
 

This function destroys this oaExtrapolateType class.

Member Function Documentation

const oaString & oaExtrapolateType::getName (    )  const
 

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

oaExtrapolateType::operator oaExtrapolateTypeEnum (    )  const [inline]
 

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