oaView Class Reference

Inheritance diagram for oaView:

oaDMContainer oaDMObject oaObject


Public Methods

void destroy ()
void getName (oaScalarName &name) const
void getName (const oaNameSpace &ns, oaString &out) const
oaViewType * getViewType () const
oaCollection< oaCellView, oaView > getCellViews () const

Static Public Methods

oaView * find (const oaLib *lib, const oaScalarName &name, const oaViewType *viewType)
oaView * get (const oaLib *lib, const oaScalarName &name, const oaViewType *viewType)

Public Types

enum  { dtIndex = oacViewDataType }

Detailed Description

The oaView class implements an OpenAccess library view object.

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

Note: The oaView function descriptions indicate if library access is required for the called function. If the access type must be write access, this requirement also is noted.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Member Function Documentation

void oaView::destroy (    ) 
 

This function destroys this oaView.

This function requires write access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if write access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

oaView * oaView::find (  const oaLib *    lib,
const oaScalarName &    name,
const oaViewType *    viewType
)  [static]
 

This function finds and returns the view with the specified name and viewType if it exists. If not found, NULL is returned.

If the DM system plug-in in use does not support explicit view creation (such as, oaDMFileSys), this function will always return a view with the specified name and viewType.

This function requires access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Parameters:
lib 
name 
viewType 
Exceptions:
oacLibAccessDenied 

oaView * oaView::get (  const oaLib *    lib,
const oaScalarName &    name,
const oaViewType *    viewType
)  [static]
 

This function finds and returns the view with the specified name if it exists. If not found, it is created, and the new view is returned.

This function requires write access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if write access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

oaCollection< oaCellView, oaView > oaView::getCellViews (    )  const
 

This function returns a collection of the cellViews which are defined using this view.

This function requires access to the library associated with this object (through a call to oaLib::getAccess). An oacLibAccessDenied exception is thrown if access to the library does not exist.

For more information on library access, see Library Access in the detailed description for oaLib and OpenAccess 2.2 Libraries and Design Management in the Programmers Guide.

Exceptions:
oacLibAccessDenied 

void * oaView::getName (  const oaNameSpace &    ns,
oaString &    out
)  const
 

This function returns the name of this view in the specified namespace.

void * oaView::getName (  oaScalarName &    name )  const
 

This function returns the name of this view.

oaViewType oaView::getViewType (    )  const
 

This function returns the viewType of this view.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.