oaParamArray Class Reference

Inheritance diagram for oaParamArray:

oaArray<oaParam> oaArrayBase<oaParam>


Public Methods

 oaParamArray (oaUInt4 sizeIn=0)
 oaParamArray (const oaParamArray &paramsIn)
oaUInt4 find (const oaParam &param) const
oaBoolean find (const oaString &name, oaParam &param) const
virtual oaBoolean operator== (const oaArray< oaParam > &p) const

Detailed Description

The oaParamArray class implements an array of oaParam objects. Arrays of parameters are typically used to set or retrieve the data for parameterized designs (pCells) and instances.

Constructor & Destructor Documentation

oaParamArray::oaParamArray (  oaUInt4    sizeIn = 0 ) 
 

This function constructs an oaParamArray object, setting the number of parameters, and allocating storage for the parameters.

Parameters:
sizeIn An integer value indicating the initial size of the parameter array

oaParamArray::oaParamArray (  const oaParamArray &    paramsIn ) 
 

This function constructs an oaParamArray instance by creating a copy of the specified oaParamArray object 'paramsIn'.

Parameters:
paramsIn A reference to an existing oaParamArray object whose elements are to be copied for creating this oaParamArray object

Member Function Documentation

oaBoolean oaParamArray::find (  const oaString &    nameIn,
oaParam &    param
)  const
 

This function searches the parameters of this oaParamArray for a parameter with the specified name. If found, the specified param is filled and true is returned. Otherwise, false is returned.

Parameters:
nameIn A reference to an oaString object that represents the name of the oaParam object being searched in this oaParamArray object
param A reference to an oaParam object to be populated if an oaParam object with the specified name is found in this array

oaUInt4 oaParamArray::find (  const oaParam &    param )  const [inline]
 

This function searches the parameters of this paramArray looking for the specified parameter param. If found, the index of the matching param is returned as an unsigned integer, otherwise the oacNullIndex value is returned.

Parameters:
param input parameter to look for in this paramArray

Reimplemented from oaArray<oaParam>.

oaBoolean oaParamArray::operator== (  const oaArray< oaParam > &    p )  const [virtual]
 

This operator compares this oaParamArray with the specified p oaParamArray object, and returns true if the objects are equal.

Reimplemented from oaArray<oaParam>.

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.