oaLibDMData Class Reference

Inheritance diagram for oaLibDMData:

Static Public Methods
oaLibDMData *	open (const oaScalarName &libName, oaChar mode)
oaLibDMData *	recover (const oaScalarName &libName, oaSaveRecoverType saveRecoverType)
oaLibDMData *	find (const oaScalarName &libName)
oaBoolean	exists (const oaScalarName &libName)
oaBoolean	exists (const oaScalarName &libName, oaSaveRecoverType saveRecoverType)
void	destroy (const oaScalarName &libName)
void	destroy (const oaScalarName &libName, oaSaveRecoverType saveRecoverType)

---

Detailed Description

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

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

---

Member Function Documentation

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

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

void oaLibDMData::destroy (  const oaScalarName &    libName )  [static]

This function attempts to remove this oaLibDMData from disk. It throws an exception if the oaLibDMData is currently open or if the oaLibDMData cannot be found on disk. Parameters: libName  name of the library associated with the DMData Exceptions: oacLibNotFound  the library with the specified name cannot be found oacDestroyDMDataOpen  the DMData is open oacDMDataCannotGetWriteAccess  cannot get write access to the DMData oacDestroyDMDataDoesNotExist  the DM Data does not exist on disk

oaBoolean oaLibDMData::exists (  const oaScalarName &    libName, 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 saveRecoverType  Either oacAutoSaveType or oacCriticalSaveType

oaBoolean oaLibDMData::exists (  const oaScalarName &    libName )  [static]

This function returns true if there is an oaLibDMData object open for the given library or if an oaLibDMData file exists on disk with a non-zero size. Parameters: libName  name of the library associated with the DMData

oaLibDMData * oaLibDMData::find (  const oaScalarName &    libName )  [static]

This function attempts to find and open the oaLibDMData for the named library. If successful, a pointer to the oaLibDMData object is returned; otherwise, NULL is returned. Parameters: libName  name of the library associated with the DMData

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

This function attempts to open the oaLibDMData object for the library with the specified name in the specified mode. If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaLibDMData does not exist, it will be created. If the specified mode is a read-access mode ('r'ead-only mode) and the oaLibDMData does not exist, an oacDMDataDoesNotExist exception will be thrown. If successful, a pointer to the LibDMData object is returned. Parameters: libName  name of the library associated with the DMData mode  'read-only,' 'a'ppend, or 'w'rite mode in which to access the DMData; 'a'ppend and 'w'rite mode attempt to obtain write access to data; 'a'ppend retains any existing LibDMData; while'w'rite deletes (truncates) any existing DMData Exceptions: oacOpenUndefinedModeDMData  The specified mode is invalid oacLibNotFound  the library with the specified name could not be found oacOpenOnDMDataBeingPurged  attempt to open DMData while DMData is being purged oacDMDataCannotGetReadAccess  requested read access to the DMData could not be obtained oacDMDataHasReadNeedWriteAccess  write access was requested but read access exists on DMData oacDMDataCannotGetWriteAccess  requested write access to the DMData could not be obtained oacDMDataDoesNotExist  read access requested, but DMData does not exist oacCannotLockDMData  write access specified, but cannot get a write lock on the file.

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

This function attempts to recover the DM data for the given library name with the specified oaSaveRecoverType. If successful, a pointer to the oaLibDMData object is returned. Parameters: libName  The name of the library saveRecoverType  Either oacAutoSaveType or oacCriticalSaveType Exceptions: oacLibNotFound  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.