oaIntRangeProp Class Reference

Inheritance diagram for oaIntRangeProp:

oaProp oaObject


Public Methods

oaInt4 getValue () const
oaInt4 getLowerBound () const
oaInt4 getUpperBound () const
void setValue (oaInt4 value)
void set (oaInt4 lowerBound, oaInt4 value, oaInt4 upperBound)

Static Public Methods

oaIntRangeProp * create (oaObject *object, const oaString &name, oaInt4 lowerBound, oaInt4 value, oaInt4 upperBound)

Detailed Description

The oaIntRangeProp is a property that has an integer-type value as well as a range of valid values that the integer is allowed to take on. The range 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

oaIntRangeProp * oaIntRangeProp::create (  oaObject *    object,
const oaString &    name,
oaInt4    lowerBound,
oaInt4    value,
oaInt4    upperBound
)  [static]
 

This function creates an integer-range 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 on which to attach the property.
name The property name.
lowerBound The lower bound for the range.
value The property value.
upperBound The upper bound for the range.
Returns:
A pointer to the oaIntRangeProp
Exceptions:
oacInvalidObjForProp 
oacInvalidValueForIntRange 
oacPropNameUsed 

oaInt4 oaIntRangeProp::getLowerBound (    )  const
 

This function returns the lower bound of the integer range.

oaInt4 oaIntRangeProp::getUpperBound (    )  const
 

This function returns the upper bound of the integer range.

oaInt4 oaIntRangeProp::getValue (    )  const
 

This function returns the value of this property.

void oaIntRangeProp::set (  oaInt4    lowerBound,
oaInt4    value,
oaInt4    upperBound
) 
 

This function sets the attributes for this property.

Parameters:
lowerBound The lower bound for the range
value The property value
upperBound The upper bound for the range
Exceptions:
oacInvalidValueForIntRange 

void oaIntRangeProp::setValue (  oaInt4    value ) 
 

This function sets this property to the specified value.

Parameters:
value The property value
Exceptions:
oacInvalidValueForIntRange 

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.