oaViewType Class Reference

Inheritance diagram for oaViewType:

oaSessionObject oaObject


Public Methods

void getName (oaString &name) const

Static Public Methods

oaViewType * create (const oaString &name)
oaViewType * find (const oaString &name)
oaViewType * get (oaReservedViewType type)
oaCollection< oaViewType, oaSession > getViewTypes ()

Detailed Description

This session object represents the type of a view. See oaReservedViewType for predefined OpenAccess viewTypes.

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

Member Function Documentation

oaViewType * oaViewType::create (  const oaString &    name )  [static]
 

This function creates a viewType with the specified name. An exception is thrown if the viewType already exists.

Parameters:
name the name of the viewType to create
Exceptions:
oacViewTypeExists 

oaViewType * oaViewType::find (  const oaString &    name )  [static]
 

This function attempts to find the viewType with the specified name. If not found, NULL is returned.

Parameters:
name the name of the viewType to find

oaViewType * oaViewType::get (  oaReservedViewType    type )  [static]
 

This function gets a pointer to a viewType that corresponds to the specified type oaReservedViewType.

Parameters:
type an oaReservedViewType wrapper object

void oaViewType::getName (  oaString &    name )  const
 

This function returns the string name of this viewType.

Parameters:
name returned name of this viewType

oaCollection< oaViewType, oaSession > oaViewType::getViewTypes (    )  [static]
 

This function returns a collection of viewTypes in this session.

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.