oaEnumProp Class Reference

Inheritance diagram for oaEnumProp:

oaProp oaObject


Public Methods

void getValue (oaString &value) const
void setValue (const oaString &value)
oaEnumCollection getEnums () const

Static Public Methods

oaEnumProp * create (oaObject *object, const oaString &name, const oaString &value, oaUInt4 numEnums, const oaString *enums)
oaEnumProp * create (oaObject *object, const oaString &name, const oaString &value, const oaStringArray &enums)

Detailed Description

The oaEnumProp is a property that has a string value as well as an array of strings that constitute the set of allowed values. This array of "enum values" can be used by a generic property editor to assist a user to enter a proper value.

Properties are application-defined values that can be added to any managed object in oaDesign, oaTech, and oaWafer databases except for the following paged objects: oaDevice, oaNode, oaParasiticNetwork, and oaSubNetwork.

To create properties on DM Objects, create the corresponding oaDMData object (using oaLibDMData::open, oaCellDMData::open, oaViewDMData::open, or oaCellViewDMData::open), then create properties on that oaDMData object.

See oaProp for a general discussion of properties.

Member Function Documentation

oaEnumProp * oaEnumProp::create (  oaObject *    object,
const oaString &    name,
const oaString &    value,
const oaStringArray &    enums
)  [static]
 

This function creates an enumerated property with the specified attributes. An exception is thrown if a property already exists on the object with the specified name or if the specified value doesn't match one of the enumerated values.

Exceptions:
oacInvalidObjForProp 
oacInvalidEnumValue 

oaEnumProp * oaEnumProp::create (  oaObject *    object,
const oaString &    name,
const oaString &    value,
oaUInt4    numStrings,
const oaString *    enums
)  [static]
 

This function creates an enumerated property with the specified attributes. The specified name is checked to verify it is unique for properties on the specified object. An exception is thrown if a property already exists on the object with the specified name. An exception is thrown if the value is not one of the strings in the array of allowed values.

Exceptions:
oacInvalidEnumValue 
oacInvalidObjForProp 
oacPropNameUsed 

oaEnumCollection oaEnumProp::getEnums (    )  const
 

This function returns a collection of the valid enums for this property.

void oaEnumProp::getValue (  oaString &    value )  const
 

This function returns the value of this property.

Reimplemented from oaProp.

void oaEnumProp::setValue (  const oaString &    value ) 
 

This function sets this property to the specified value.

Exceptions:
oacInvalidEnumValue 

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.