oaAssignment Class Reference

Inheritance diagram for oaAssignment:

oaBlockObject oaDesignObject oaObject oaAssignAssignment oaAssignValue


Public Methods

void destroy ()
void getName (oaString &name) const
oaInst * getInst () const
void setName (const oaString &name)
void setInst (oaInst *inst)

Static Public Methods

oaAssignment * find (const oaInst *inst, const oaString &name)

Public Types

enum  { dtIndex = oacAssignmentDataType }

Detailed Description

The oaAssignment class is the base class for all types of connection assignments. The oaAssignment objects specify the overriding assignments for the connection definitions specified in corresponding oaConnectDef objects. Together, these objects allow you to specify how nets are to be connected to by name in a design hierarchy.

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

See oaNetConnectDef and oaTermConnectDef for information on the specific type of connection definition. See oaAssignValue and oaAssignAssignment for information on the specific type of connection assignment.

Member Function Documentation

void oaAssignment::destroy (    ) 
 

This function destroys this assignment, removing it from the database.

oaAssignment * oaAssignment::find (  const oaInst *    inst,
const oaString &    name
)  [static]
 

This function searches the specified instance for an assignment with the specified lookup name.

Returns:
A pointer to the assignment, if found

oaInst * oaAssignment::getInst (    )  const
 

This function returns a pointer to the instance with which this assignment is associated.

void oaAssignment::getName (  oaString &    name )  const
 

This function returns the name of this assignment in the given name string. This is the name searched for when resolving the connections for the oaNetConnectDef and oaTermConnectDef objects.

void oaAssignment::setInst (  oaInst *    inst ) 
 

This function changes the instance with which this assignment is associated.

Exceptions:
oacInstAndAssignmentNotInSameBlock 

void oaAssignment::setName (  const oaString &    name ) 
 

This function changes the assignment name for this assignment object.

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.