oaStringProp Class Reference

Inheritance diagram for oaStringProp:

oaProp oaObject


Public Methods

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

Static Public Methods

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

Detailed Description

The oaStringProp is a property that has a string-type 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

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

This function creates a string property with the specified attributes. The specified name is checked to verify it is unique for properties on the specified object.

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

void oaStringProp::getValue (  oaString &    value )  const
 

This function returns the value of this property.

Reimplemented from oaProp.

void oaStringProp::setValue (  const oaString &    value ) 
 

This function sets this property to the specified value.

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.