oaAntennaModel Class Reference


Public Methods

 oaAntennaModel (oaAntennaModelEnum valueIn)
 oaAntennaModel (const oaString &name)
 ~oaAntennaModel ()
const oaString & getName () const
 operator oaAntennaModelEnum () const

Detailed Description

The oaAntennaModel class is an enum wrapper class that identifies which antenna model is being referenced by an oaAntennaData object associated with a terminal. Some technologies have more than one antenna model that reflect different process options for that technology.

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

enum oaAntennaModelEnum
 

Enumeration values:
oacDefaultAntennaModel  "defaultAntennaModel"
oacSecondAntennaModel  "secondAntennaModel"
oacThirdAntennaModel  "thirdAntennaModel"
oacFourthAntennaModel  "fourthAntennaModel"

Constructor & Destructor Documentation

oaAntennaModel::oaAntennaModel (  oaAntennaModelEnum    valueIn )  [inline]
 

This function constructs an instance of an oaAntennaModel class using the specified oaAntennaModelEnum value.

oaAntennaModel::oaAntennaModel (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidAntennaModelName 

oaAntennaModel::~oaAntennaModel (    )  [inline]
 

This function destroys this oaAntennaModel class.

Member Function Documentation

const oaString & oaAntennaModel::getName (    )  const
 

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

oaAntennaModel::operator oaAntennaModelEnum (    )  const [inline]
 

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