oaBooleanProp Class Reference

Inheritance diagram for oaBooleanProp:

oaProp oaObject


Public Methods

oaBoolean getValue () const
void setValue (oaBoolean value)

Static Public Methods

oaBooleanProp * create (oaObject *object, const oaString &name, oaBoolean value)

Detailed Description

The oaBooleanProp is a property that has a boolean (true or false) 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

oaBooleanProp * oaBooleanProp::create oaObject *    object,
const oaString &    name,
oaBoolean    value
[static]
 

This function creates a boolean property with the specified attributes.

Parameters:
object The object to which to attach the property
name The property name
value The property value
Returns:
A pointer to the oaBooleanProp
Exceptions:
oacPropNameUsed 
oacInvalidObjForProp 

oaBoolean oaBooleanProp::getValue   const
 

This function returns the value of the property.

void oaBooleanProp::setValue oaBoolean    value
 

This function sets this property to the specified value.

Parameters:
value The property value to set


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

Return to top of page