oaModAssignment Class Reference

Inheritance diagram for oaModAssignment:

oaModObject oaDesignObject oaObject oaModAssignAssignment oaModAssignValue


Public Methods

void destroy ()
void getName (oaString &name) const
oaModInstgetInst () const
void setName (const oaString &name)
void setInst (oaModInst *inst)

Static Public Methods

oaModAssignment * find (const oaModInst *inst, const oaString &name)

Public Types

enum  { dtIndex = oacAssignmentDataType }

Detailed Description

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

See oaModNetConnectDef and oaModTermConnectDef for information on the specific type of connection definition. See oaModAssignValue and oaModAssignAssignment for information on the specific type of connection assignment.

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


Member Function Documentation

void oaModAssignment::destroy  
 

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

oaModAssignment * oaModAssignment::find const oaModInst *    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

oaModInst * oaModAssignment::getInst   const
 

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

void oaModAssignment::getName oaString &    name const
 

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

void oaModAssignment::setInst oaModInst *    inst
 

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

Exceptions:
oacInstAndAssignmentNotInSameBlock 

void oaModAssignment::setName const oaString &    name
 

This function changes the assignment name for this assignment object. The name is also updated for each of the occurrences that the assignment appears in.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 


The documentation for this class was generated from the following files:

Return to top of page