oaAntennaRatioArrayValue Class Reference

Inheritance diagram for oaAntennaRatioArrayValue:

oaValue oaObject


Public Methods

oaAntennaRatioValueget (const oaAntennaModel &model) const
void set (const oaAntennaModel &model, oaAntennaRatioValue *value)

Static Public Methods

oaAntennaRatioArrayValue * create (oaObject *database, oaAntennaRatioValue *defaultModel, oaAntennaRatioValue *secondModel=NULL, oaAntennaRatioValue *thirdModel=NULL, oaAntennaRatioValue *fourthModel=NULL)

Detailed Description

The oaAntennaRatioArrayValue represents an array of antennaArrayValues, one for each antenna model.

See oaValue for a discussion of the usage of all of the oaValue subclasses.


Member Function Documentation

oaAntennaRatioArrayValue * oaAntennaRatioArrayValue::create oaObject *    database,
oaAntennaRatioValue *    defaultModel,
oaAntennaRatioValue *    secondModel = NULL,
oaAntennaRatioValue *    thirdModel = NULL,
oaAntennaRatioValue *    fourthModel = NULL
[static]
 

This function creates an antennaRatioArray value in the specified database. An antennaRatioValue is specified for each antenna model as needed. Only the defaultModel is required. All of the antennaRatioValues must be in the same database as the value being created.

Parameters:
database The database to create the value in
defaultModel The antenna ratios for the default model
secondModel The antenna ratios for the second model
thirdModel The antenna ratios for the third model
fourthModel The antenna ratios for the fourth model
Exceptions:
oacInvalidDatabase 

oaAntennaRatioValue * oaAntennaRatioArrayValue::get const oaAntennaModel &    model const
 

This function returns the antenna ratio value for the antenna model specified

Parameters:
model The antenna model to get the antenna ratios value for

void oaAntennaRatioArrayValue::set const oaAntennaModel &    model,
oaAntennaRatioValue *    value
 

This function sets the antenna ratios for the antenna model specified

Parameters:
model The model to set the ratios for
value The value of the antenna ratios to set


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

Return to top of page