oaFigGroupMem Class Reference

Inheritance diagram for oaFigGroupMem:

oaBlockObject oaDesignObject oaObject


Public Methods

void destroy ()
oaFigGroup * getFigGroup () const
oaFig * getFig () const
void moveAfter (oaFigGroupMem *mem)
void moveToFirst ()

Static Public Methods

oaFigGroupMem * create (oaFigGroup *figGroup, oaFig *fig)

Public Types

enum  { dtIndex = oacFigGroupMemDataType }

Detailed Description

An oaFigGroupMem represents the membership of an oaFig in an oaFigGroup. A figure is placed in a FigGroup by creating an oaFigGroupMem that references the oaFig and the oaFigGroup that it will be a member of. A figure is removed from a FigGroup by destroying its FigGroupMem. This class provides functions for manipulating the order in which the members of a FigGroup appear, if that FigGroup is ordered.

Member Function Documentation

static oaFigGroupMem * oaFigGroupMem::create (  oaFigGroup *    figGroup,
oaFig *    fig
)  [static]
 

This function creates a new oaFigGroupMem object making the Figure a member of the FigGroup.

Parameters:
figGroup The oaFigGroup in which the fig is added.
fig The fig to add.
Exceptions:
oacFigGroupMemberNotInSameDB 
oacFigAlreadyInFigGroup 

void oaFigGroupMem::destroy (    ) 
 

This function destroys the oaFigGroupMem thereby removing its oaFig from its FigGroup. It does not destroy the Figure.

oaFig * oaFigGroupMem::getFig (    )  const
 

This function returns the oaFig that this oaFigGroupMem encapsulates.

oaFigGroup * oaFigGroupMem::getFigGroup (    )  const
 

This function returns the oaFigGroup to which this oaFigGroupMem belongs.

void oaFigGroupMem::moveAfter (  oaFigGroupMem *    mem ) 
 

This function moves this oaFigGroupMem in the oaFigGroup's ordering and positions this oaFigGroupMem after the specified member.

Parameters:
mem The member after which the oaFigGroupMem is positioned.
Exceptions:
oacInvalidFigGroupTypeForMemberMove 
oacFigGroupMemberNotInSameDB 
oacFigGroupMemberNotInSameFigGroup 

void oaFigGroupMem::moveToFirst (    ) 
 

This function moves this oaFigGroupMem to the first position in the oaFigGroup's ordering.

Exceptions:
oacInvalidFigGroupTypeForMemberMove 

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.