oaFloatRangeProp Class Reference

Inheritance diagram for oaFloatRangeProp:

oaProp oaObject


Public Methods

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

Static Public Methods

oaFloatRangeProp * create (oaObject *object, const oaString &name, oaFloat lowerBound, oaFloat value, oaFloat upperBound)

Detailed Description

The oaFloatRangeProp is a property that has a float-type value as well as a range of valid values that the float 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

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

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

Parameters:
object The object to 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 oaFloatRangeProp
Exceptions:
oacPropNameUsed 
oacInvalidValueForFloatRange 
oacInvalidObjForProp 

oaFloat oaFloatRangeProp::getLowerBound (    )  const
 

This function returns the lower bound of the float range.

oaFloat oaFloatRangeProp::getUpperBound (    )  const
 

This function returns the upper bound of the float range.

oaFloat oaFloatRangeProp::getValue (    )  const
 

This function returns the value of this property.

void oaFloatRangeProp::set (  oaFloat    lowerBound,
oaFloat    value,
oaFloat    upperBound
) 
 

This function sets this property attributes.

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

void oaFloatRangeProp::setValue (  oaFloat    value ) 
 

This function sets this property to the specified value.

Parameters:
value The property value
Exceptions:
oacInvalidValueForFloatRange 

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.