oaViewDMData Class Reference

Inheritance diagram for oaViewDMData:

Public Methods
void	getViewName (oaScalarName &viewName) const
void	getViewName (const oaNameSpace &ns, oaString &viewName) const
oaViewType *	getViewType () const
Static Public Methods
oaViewDMData *	open (const oaScalarName &libName, const oaScalarName &viewName, const oaViewType *viewType, oaChar mode)
oaViewDMData *	find (const oaScalarName &libName, const oaScalarName &viewName, const oaViewType *viewType)
oaBoolean	exists (const oaScalarName &libName, const oaScalarName &viewName, const oaViewType *viewType)
void	destroy (const oaScalarName &libName, const oaScalarName &viewName, const oaViewType *viewType)

---

Detailed Description

oaViewDMData objects represent database objects that can be associated with a DM view 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 oaViewDMData::destroy (  const oaScalarName &    libName, const oaScalarName &    viewName, const oaViewType *    viewType )  [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 to use viewName  The name of the view whose ViewDMData is to be destroyed viewType  The specific viewType of the view whose ViewDMData is to be destroyed Exceptions: oacDMDataHasReadNeedWriteAccess  oacDMDataCannotGetWriteAccess  oacLibNotFound  oacDestroyDMDataDoesNotExist  oacDestroyDMDataOpen

oaBoolean oaViewDMData::exists (  const oaScalarName &    libName, const oaScalarName &    viewName, const oaViewType *    viewType )  [static]

This function checks if 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 in which to look viewName  The name of the view whose ViewDMData existence is to be checked viewType  The viewType of the view whose ViewDMData existence is to be checked Exceptions: oacDMDataCannotGetReadAccess

oaViewDMData * oaViewDMData::find (  const oaScalarName &    libName, const oaScalarName &    viewName, const oaViewType *    viewType )  [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 to look viewName  The name of the view whose ViewDMData is to be found viewType  The viewType of the view whose ViewDMData is to be found Exceptions: oacDMDataCannotGetReadAccess

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

This function returns the name of the view to which this ViewDMData object belongs. Parameters: ns  The namespace to be used to populate the viewName parameter viewName  A reference to an oaString object to be populated with the view name Exceptions: oacInvalidView

void oaViewDMData::getViewName (  oaScalarName &    viewName )  const

This function returns the name of the view to which this ViewDMData object belongs. Parameters: viewName  A reference to the oaScalarName object that will be populated with the name of the view Exceptions: oacInvalidView

oaViewType * oaViewDMData::getViewType (    )  const

This function returns the viewType of the view to which this ViewDMData object belongs. Exceptions: oacInvalidView

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

This function attempts to open the oaViewDMData object for the view with the specified name and viewType 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 oaViewDMData does not exist, it will be created. If the specified mode is a read-access mode ('r'ead-only mode) and the oaViewDMData does not exist, an oacDMDataDoesNotExist exception will be thrown. If successful, a pointer to the ViewDMData object is returned. Parameters: libName  The name of the library viewName  The name of the view whose ViewDMData is to be opened viewType  The viewType of the view to be opened mode  The mode in which to open the ViewDMData Exceptions: oacOpenUndefinedModeDMData  oacLibNotFound  oacViewNotFound  oacDMDataCannotGetReadAccess  oacDMDataHasReadNeedWriteAccess  oacDMDataCannotGetWriteAccess

---

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.