oaLibDefListRef Class Reference

Inheritance diagram for oaLibDefListRef:

oaLibDefListMem oaSessionObject oaObject


Public Methods

void getRefListPath (oaString &path) const

Static Public Methods

oaLibDefListRef * create (oaLibDefList *libList, const oaString &refListPath, oaLibDefListMem *followingMem=NULL)
oaLibDefListRef * find (const oaLibDefList *defList, const oaString &refListPath)

Detailed Description

oaLibDefListRef is a derived class of oaLibDefListMem. It represents a reference to a another library definition list in the owning oaLibDefList.

Member Function Documentation

oaLibDefListRef * oaLibDefListRef::create (  oaLibDefList *    libList,
const oaString &    refListPath,
oaLibDefListMem *    followingMem = NULL
)  [static]
 

This function creates the libDefListRef object in the owning libList with the the given parameters. Exceptions will be thrown if a reference object already exists with the same path as refListPath.

This object will be created in the owning libList before the specified followingMem, which must be in the same owning list. If followinMem is not specified (or if NULL is specified), this object will be positioned at the end of the owning libList.

Parameters:
libList input parameter - The oaLibDefList in which this oaLibDefListRef will be created.
refListPath input parameter - The path to the file of the referred libDefList. A relative path can be specified, which must be relative to the path of the file of the owning libList.
followingMem optional input parameter - The member in the owning libList list that this libDef will be positioned in front of. If this parameter is not specified (or if NULL is specified), this oaLibDefListRef will be positioned at the end of the owning libList.
Exceptions:
oacLibDefListRefExists 
oacInvalidLibDefListMemCreate 

oaLibDefListRef * oaLibDefListRef::find (  const oaLibDefList *    defList,
const oaString &    refListPath
)  [static]
 

This function attempts to find and return the libDefListRef object in the owning defList that refers to a libDefList at the specified refListPath.

Parameters:
defList input parameter - The owning oaLibDefList to search.
refListPath input parameter- The path to the file of the referred libDefList. A Relative path may be specified, which must be relative to the path of the file of the owning defList.

void oaLibDefListRef::getRefListPath (  oaString &    path )  const
 

This function fills in the path to the referred list of this libDefListRef object.

Parameters:
path output parameter - the path to the referred libDefList.

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.