oaConstraintParamDef Class Reference

Inheritance diagram for oaConstraintParamDef:

oaSessionObject oaObject


Public Methods

void getName (oaString &name) const
oaType getValueType () const
oaBoolean isBuiltIn () const
void destroy ()
void remove (oaObject *database)

Static Public Methods

oaConstraintParamDef * create (const oaString &name, oaType valueType)
oaConstraintParamDef * find (const oaString &name)
oaConstraintParamDef * get (oaConstraintParamType type)

Public Types

enum  { dtIndex = oacBaseConstraintParamDefDataType }

Detailed Description

The oaConstraintParamDef object specifies a definition for a particular constraint parameter. The definition contains a name and the valueType that is allowed for the parameter. The names for constraint parameter definitions must be unique.

The oaConstraintParamDef class can be observed by deriving from oaObserver<oaConstraintParamDef>.

See Uniqueness of Session Objects for information about the requirement that session objects be unique.

Member Function Documentation

oaConstraintParamDef * oaConstraintParamDef::create (  const oaString &    name,
oaType    valueType
)  [static]
 

This function creates a new oaConstraintParamDef. It is an error if the name of the constraintParamDef already exists. It is an error if the type specified is not an oaValueType.

Parameters:
name The oaString name of the parameter.
valueType The value type for the parameter.
Exceptions:
oacConstraintParamDefExists 
oacInvalidValueType 

void oaConstraintParamDef::destroy (    ) 
 

This function destroys this constraintParamDef. If this is a built in type or any databases currently reference this def, an exception is thrown. An exception is also thrown if this function is called when undo is enabled on any of the current in-memory design or tech databases.

Exceptions:
oacUnableToDestroyBuiltInType 
oacConstraintParamDefHasReference 
oacCannotDestroyDefUndo 

oaConstraintParamDef * oaConstraintParamDef::find (  const oaString &    name )  [static]
 

This function finds the constraint parameter by name. If the parameter is not found NULL is returned.

Parameters:
name The parameter name to search for.

oaConstraintParamDef * oaConstraintParamDef::get (  oaConstraintParamType    type )  [static]
 

This function returns the constraintParamDef for the built in type specified.

Parameters:
type The built-in type to search for.

void oaConstraintParamDef::getName (  oaString &    name )  const
 

This function returns the name of the constraintParamDef.

Parameters:
name The returned name.

oaType oaConstraintParamDef::getValueType (    )  const
 

This function returns the value type of this constraintParamDef.

oaBoolean oaConstraintParamDef::isBuiltIn (    )  const
 

This function returns true if this constraint param def is a built-in def.

void oaConstraintParamDef::remove (  oaObject *    database ) 
 

This function removes the constraintParamDef from the database specified. If any constraints in that database currently reference this def an error is thrown.

Parameters:
database Database to remove the definition from
Exceptions:
oacConstraintParamDefHasReference 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.