oaAntennaAreaArray Class Reference

Inheritance diagram for oaAntennaAreaArray:

oaArray<oaAntennaArea> oaArrayBase<oaAntennaArea>


Public Methods

 oaAntennaAreaArray (oaUInt4 sizeIn=0)
 oaAntennaAreaArray (const oaAntennaAreaArray &aIn)
void compress ()
void sort ()

Detailed Description

The oaAntennaAreaArray class implements an array of oaAntennaArea values. The allocated size of the oaAntennaAreaArray can be different from the number of values actually stored. This is useful when the oaAntennaAreaArray is used repeatedly since it reduces the need to reallocate the array.


Constructor & Destructor Documentation

oaAntennaAreaArray::oaAntennaAreaArray oaUInt4    sizeIn = 0
 

This function constructs an oaAntennaAreaArray object, allocating storage for sizeIn oaAntennaArea elements.

Parameters:
sizeIn number of values for which to allocate storage; the default number is 0.

oaAntennaAreaArray::oaAntennaAreaArray const oaAntennaAreaArray &    aIn [inline]
 

This is the oaAntennaAreaArray copy constructor, which creates a copy of the specified aIn oaAntennaAreaArray.

Parameters:
aIn oaAntennaAreaArray to copy


Member Function Documentation

void oaAntennaAreaArray::compress  
 

This function removes duplicate area values that have specified for the same layer in this antennaAreaArray. The compression keeps the latest area value in the array for any given layer. The size of the array is not changed.

void oaAntennaAreaArray::sort  
 

This function sorts the data in this oaAntennaAreaArray object so the layer number values are ascending. Any oaAntennaArea values with no layer number specified (such as those where the value is oacNullIndex) appear first in the array.


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

Return to top of page