oaCellDMData Class Reference

Inheritance diagram for oaCellDMData:

Public Methods
void	getCellName (oaScalarName &cellName) const
void	getCellName (const oaNameSpace &ns, oaString &cellName) const
Static Public Methods
oaCellDMData *	open (const oaScalarName &libName, const oaScalarName &cellName, oaChar mode)
oaCellDMData *	recover (const oaScalarName &libName, const oaScalarName &cellName, oaSaveRecoverType saveRecoverType)
oaCellDMData *	find (const oaScalarName &libName, const oaScalarName &cellName)
oaBoolean	exists (const oaScalarName &libName, const oaScalarName &cellName)
oaBoolean	exists (const oaScalarName &libName, const oaScalarName &cellName, oaSaveRecoverType saveRecoverType)
void	destroy (const oaScalarName &libName, const oaScalarName &cellName)
void	destroy (const oaScalarName &libName, const oaScalarName &cellName, oaSaveRecoverType saveRecoverType)

---

Detailed Description

oaCellDMData objects represent database objects that can be associated with a DM cell and can be used to persistently store properties (oaProp objects), groups (oaGroup objects), group members (oaGroupMember objects) and application objects (see oaAppObject.)

---

Member Function Documentation

void oaCellDMData::destroy (  const oaScalarName &    libName, const oaScalarName &    cellName, oaSaveRecoverType    saveRecoverType )  [static]

This function attempts to remove the specified oaSaveRecoverType file from disk. It throws an exception if this file is not found on disk. Parameters: libName  The name of the library cellName  The name of the cell for which the oaCellDMData is to be destroyed saveRecoverType  Either oacAutoSaveType or oacCriticalSaveType Exceptions: oacLibNotFound  oacDestroyDMDataDoesNotExist  oacSaveRecoverFileDoesNotExistOnDisk  oacInterfaceException

void oaCellDMData::destroy (  const oaScalarName &    libName, const oaScalarName &    cellName )  [static]

This function attempts to remove the dmData from disk. It throws an exception if the dmData is currently open or if the dmData cannot be found on disk. Parameters: libName  The name of the library cellName  The name of the cell whose CellDMData is to be destroyed Exceptions: oacLibNotFound  oacDestroyDMDataDoesNotExist  oacDMDataHasReadNeedWriteAccess  oacDMDataCannotGetWriteAccess  oacDestroyDMDataOpen  oacDestroyDMDataDoesNotExist

oaBoolean oaCellDMData::exists (  const oaScalarName &    libName, const oaScalarName &    cellName, oaSaveRecoverType    saveRecoverType )  [static]

This function returns a boolean that indicates whether the specified oaSaveRecoverType file exists on-disk. Parameters: libName  The name of the library to check cellName  The name of the cell to check saveRecoverType  Either oacAutoSaveType or oacCriticalSaveType

oaBoolean oaCellDMData::exists (  const oaScalarName &    libName, const oaScalarName &    cellName )  [static]

This function checks whether there is a DMData open for the given library, or if a DMData file exists on disk with a non-zero size. Parameters: libName  The name of the library to check cellName  The name of the cell to checked Exceptions: oacDMDataCannotGetReadAccess

oaCellDMData * oaCellDMData::find (  const oaScalarName &    libName, const oaScalarName &    cellName )  [static]

This function attempts to find an open DM data for the given library. If successful, a pointer to the DMData object is returned; otherwise, NULL is returned. Parameters: libName  The name of the library in which the lookup will happen cellName  The name of the cell whose CellDMData is to be found Exceptions: oacDMDataCannotGetReadAccess

void oaCellDMData::getCellName (  const oaNameSpace &    ns, oaString &    cellName )  const

This function returns the cell name for this oaCellDMData object in the specified nameSpace. Parameters: ns  input parameter - the name space in which to return the cell name cellName  the returned oaString cell name Exceptions: oacInvalidCell  oacDMDataCannotGetReadAccess

void oaCellDMData::getCellName (  oaScalarName &    cellName )  const

This function returns the cell name for this oaCellDMData object. Parameters: cellName  the returned oaScalarName cell name Exceptions: oacInvalidCell

oaCellDMData * oaCellDMData::open (  const oaScalarName &    libName, const oaScalarName &    cellName, oaChar    mode )  [static]

This function attempts to open the oaCellDMData object for the cell with the specified name in the specified library with the specified mode. If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaCellDMData does not exist, it will be created. If the specified mode is a read-access mode ('r'ead-only mode) and the oaCellDMData does not exist, an oacDMDataDoesNotExist exception will be thrown. If successful, a pointer to the CellDMData object is returned. Parameters: libName  The name of the library to use cellName  The name of the cell whose DMData is to be opened mode  The mode to use to open the DMData Exceptions: oacOpenUndefinedModeDMData  oacLibNotFound  oacCellNotFound  oacDMDataCannotGetReadAccess  oacDMDataHasReadNeedWriteAccess  oacDMDataCannotGetWriteAccess

oaCellDMData * oaCellDMData::recover (  const oaScalarName &    libName, const oaScalarName &    cellName, oaSaveRecoverType    saveRecoverType )  [static]

This function attempts to recover the DM data for the given library and cell name with the specified oasSaveRecoverType. If successful, a pointer to the oaCellDMData object is returned. Parameters: libName  The name of the library cellName  The name of the cell saveRecoverType  Either oacAutoSaveType or oacCriticalSaveType Exceptions: oacLibNotFound  oacReadLibAccess  oacCellNotFound  oacSaveRecoverDMDataFileAlreadyOpened  oacOpenOnDMDataBeingPurged  oacDMDataDoesNotExist  oacSaveRecoverFileDoesNotExistOnDisk  oacInterfaceException

---

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

• oaDMData.h
• oaDMData.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.