oaDMContainer Class Reference

Inheritance diagram for oaDMContainer:

oaDMObject oaObject oaCell oaCellView oaLib oaView


Public Methods

oaCollection< oaDMFile, oaDMContainer > getDMFiles () const
oaDMObjectStatusRefIter getVCStatus (oaVCQueryDepth depth, oaUInt4 mask=oacVCStatusAll) const
oaUInt4 getVCStatus (oaUInt4 mask=oacVCStatusAll) const

Detailed Description

The oaDMContainer class is the base for all classes that are file containers.

Member Function Documentation

oaCollection< oaDMFile, oaDMContainer > oaDMContainer::getDMFiles (    )  const
 

This function constructs and returns a collection of files in the container.

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:
oacInvalidContainer 
oacLibAccessDenied 

oaUInt4 oaDMObject::getVCStatus (  oaUInt4    mask = oacVCStatusAll )  const
 

This function is only active when a Version Control system is in place for the library this object is in. It gets the version control status of the object. This status only relates to the given object and is not hierarchical.

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:
mask this parameter is used to limit the status bits being retrieved. Some types of status are more expensive to discover than others; use this mask to optimize performance
Exceptions:
oacLibAccessDenied 

oaDMObjectStatusRefIter oaDMContainer::getVCStatus (  oaVCQueryDepth    depth = oacCellViewFileVCQueryDepth,
oaUInt4    mask = oacVCStatusAll
)  const
 

This function is only active when a Version Control system is in place for the library this object is in. It gets the version control status of the children of this container. Use "depth" to control how far down the hierarchy to traverse.

Parameters:
depth this parameter is used to control the depth that this function will go in the hierarchy when applying this operation. The enum values have the following meanings: oacFileVCQueryDepth: query only the immediate children files of this container oacCellVCQueryDepth: stop the query at the Cell level, not including "cell files" oacViewVCQueryDepth: stop the query at the View level, not including "view files" oacCellViewVCQueryDepth: stop the query at the CellView level, not including "cellView" files oacCellViewFileVCQueryDepth: stop the query at the CellView file level. This is currently the lowest level oacMaxQueryDepth: query to the bottom of the hierarchy
mask this parameter is used to limit the status bits being retrieved. Some types of status are more expensive to discover than others; use this mask to optimize performance
Exceptions:
oacLibAccessDenied 

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.