oaCellViewDMData Class Reference

Inheritance diagram for oaCellViewDMData:

oaDMData oaObject


Public Methods

void getCellName (oaScalarName &cellName) const
void getCellName (const oaNameSpace &ns, oaString &cellName) const
void getViewName (oaScalarName &viewName) const
void getViewName (const oaNameSpace &ns, oaString &viewName) const
oaViewType * getViewType () const

Static Public Methods

oaCellViewDMData * open (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, const oaViewType *viewType, oaChar mode)
oaCellViewDMData * open (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, oaChar mode)
oaCellViewDMData * recover (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, oaSaveRecoverType saveRecoverType)
oaCellViewDMData * find (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
oaBoolean exists (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
oaBoolean exists (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, oaSaveRecoverType saveRecoverType)
void destroy (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
void destroy (const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, oaSaveRecoverType saveRecoverType)

Detailed Description

oaCellViewDMData objects represent database objects that can be associated with a DM cellView 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 oaCellViewDMData::destroy (  const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
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
cellName The name of the cell
viewName The name of the view
saveRecoverType Either oacAutoSaveType or oacCriticalSaveType
Exceptions:
oacLibNotFound 
oacDestroyDMDataDoesNotExist 
oacSaveRecoverFileDoesNotExistOnDisk 
oacInterfaceException 

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

This function attempts to remove the CellViewDMData object associated with the given library, cellName and viewName from disk. It throws an exception if the CellViewDMData is currently open or if the CellViewDMData cannot be found on disk.

Parameters:
libName The name of the library associated with the DM Data
cellName The name of the cell
viewName The name of the view
Exceptions:
oacDestroyDMDataOpen 
oacDestroyDMDataDoesNotExist 
oacDMDataCannotGetWriteAccess 

oaBoolean oaCellViewDMData::exists (  const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
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
cellName The name of the cell
viewName The name of the view
saveRecoverType Either oacAutoSaveType or oacCriticalSaveType

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

This function returns a boolean that indicates if there is a CellViewDMData object open for the given library, cellName and viewName, or if a CellViewDMData file exists on disk with a non-zero size.

Parameters:
libName The name of the library associated with the DM Data
cellName The name of the cell
viewName The name of the view

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

This function attempts to find an open CellViewDMData for the given library, cellName and viewName. If successful, a pointer to the DMData object is returned; otherwise, NULL is returned.

Parameters:
libName the name of the library associated with the DM Data
cellName the name of the cell
viewName the name of the view

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

This function returns name for this oaCellViewDMData object as an oaString in the specified namespace.

Parameters:
ns input parameter - the nameSpace in which to return the cell name
cellName the returned oaString cell name
Exceptions:
oacInvalidCellView 

void oaCellViewDMData::getCellName (  oaScalarName &    cellName )  const
 

This function returns the cell name for this CellDMData object.

Parameters:
cellName the returned oaScalarName cell name
Exceptions:
oacInvalidCellView 

void oaCellViewDMData::getViewName (  const oaNameSpace &    ns,
oaString &    viewName
)  const
 

This function returns the view name for this oaCellViewDMData object in the specified nameSpace.

Parameters:
ns input parameter - the namespace in which to return the view name
viewName the returned oaString view name
Exceptions:
oacInvalidCellView 

void oaCellViewDMData::getViewName (  oaScalarName &    viewName )  const
 

This function returns the view name for this oaCellViewDMData object.

Parameters:
viewName the returned oaScalarName view name
Exceptions:
oacInvalidCellView 

oaViewType * oaCellViewDMData::getViewType (    )  const
 

This function returns the view type for this oaCellViewDMData object.

Exceptions:
oacInvalidCellView 

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

This function attempts to open the oaCellViewDMData object for the cellView identified by the specified library, cell and view names with the specified mode. If the specified mode is a write-access mode ('a'ppend or 'w'rite mode) and the oaCellViewDMData does not exist, it will be created. If the specified mode is a read-access mode ('r'ead-only mode) and the oaCellViewDMData does not exist, an oacDMDataDoesNotExist exception will be thrown.

If successful, a pointer to the CellViewDMData object is returned.

Parameters:
libName the name of the library associated with the DM Data
cellName the name of the cell associated with the DM Data
viewName the name of the view associated with the DM Data
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 
oacLibNotFound 
oacDMDataCannotGetReadAccess 
oacDMDataHasReadNeedWriteAccess 
oacDMDataCannotGetWriteAccess 
oacCellViewOwnerDoesNotExist 

oaCellViewDMData * oaCellViewDMData::open (  const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
const oaViewType *    viewType,
oaChar    mode
)  [static]
 

This function attempts to open the DM data for the cellView specified with libName, cellName, viewName and viewType in the specified mode. If the mode is not 'r'ead-only mode, the cell and view will be created if they did not exist prior to this open() call. In the 'r'ead-only mode, the specified cellView and its owners must exist, otherwise an oacCellViewOwnerDoesNotExist exception is thrown. Also, for existing cellViews, the viewType specified must match the existing view's viewType for the open to be successful. An exception is thrown otherwise. If successful, a pointer to the CellViewDMData object is returned.

Parameters:
libName the name of the library associated with the DM Data
cellName the name of the cell associated with the DM Data
viewName the name of the view associated with the DM Data
viewType the viewType of the cellView associated with the DM Data
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 undefined mode (must be 'r'ead-only, 'w'rite or 'a'ppend)
oacCellViewOwnerDoesNotExist read mode specified, but either or both the cell and view owners do not exist
oacLibNotFound the library with the specified name could not be found
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
oacOpenOnDMDataBeingPurged attempt to open DMData while DMData is being purged
oacDMDataDoesNotExist read access requested, but DMData does not exist
oacCannotLockDMData write access specified, but cannot get a write lock on the file

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

This function attempts to recover the DM data for the cellView specified by libName, cellName, viewName and with the specified oaSaveRecoverType. If successful, a pointer to the oaCellViewDMData object is returned.

Parameters:
libName The name of the library
cellName The name of the cell
viewName THe name of the view
saveRecoverType Either oacAutoSaveType or oacCriticalSaveType
Exceptions:
oacLibNotFound 
oacCellViewOwnerDoesNotExist 
oacSaveRecoverDMDataFileAlreadyOpened 
oacOpenOnDMDataBeingPurged 
oacDMDataDoesNotExist 
oacSaveRecoverFileDoesNotExistOnDisk 
oacInterfaceException 

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.