oaTimeRangeProp Class Reference

Inheritance diagram for oaTimeRangeProp:

oaProp oaObject


Public Methods

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

Static Public Methods

oaTimeRangeProp * create (oaObject *object, const oaString &name, oaTime lowerBound, oaTime value, oaTime upperBound)

Detailed Description

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

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

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

Exceptions:
oacInvalidValueForIntRange 
oacInvalidObjForProp 
oacPropNameUsed 

oaTime oaTimeRangeProp::getLowerBound (    )  const
 

This function returns the lower bound of the time range.

oaTime oaTimeRangeProp::getUpperBound (    )  const
 

This function returns the upper bound of the time range.

oaTime oaTimeRangeProp::getValue (    )  const
 

This function returns the value of this property.

void oaTimeRangeProp::set (  oaTime    lowerBound,
oaTime    value,
oaTime    upperBound
) 
 

This function sets the attributes for this property.

Exceptions:
oacInvalidValueForIntRange 

void oaTimeRangeProp::setValue (  oaTime    value ) 
 

This function sets this property to the specified 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.