oaObserver<oaWafer> Class Template Reference

Inheritance diagram for oaObserver<oaWafer>:

oaBaseObserver


Public Methods

 oaObserver (oaUInt4 priorityIn, oaBoolean enabledIn=true)
virtual ~oaObserver ()
virtual void onFirstOpen (oaWafer *wafer)
virtual void onPurge (oaWafer *wafer)
virtual void onPreReopen (oaWafer *wafer, oaChar newMode)
virtual void onPostReopen (oaWafer *wafer, oaChar oldMode)
virtual void onTruncate (oaWafer *wafer)
virtual void onPreSave (oaWafer *wafer)
virtual void onPostSave (oaWafer *wafer, oaBoolean succeeded)
virtual void onPreSaveAs (oaWafer *wafer, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName)
virtual void onPostSaveAs (oaWafer *wafer, const oaScalarName &libName, const oaScalarName &cellName, const oaScalarName &viewName, oaBoolean succeeded)
virtual void onPreModify (oaWafer *wafer, oaWaferModTypeEnum modType)
virtual void onPostModify (oaWafer *wafer, oaWaferModTypeEnum modType)

Friends

class oaObserverCollectionPvt

Detailed Description

template<>
class oaObserver<oaWafer>

This base template class can be used to derive observers for oaWafer objects. It supports onFirstOpen, onPreReopen, onPostReopen, onPreModify, onPostModify, onPreSave, onPostSave, onPreSaveAs, onPostSaveAs, onPurge, and onTruncate event notifications.

See oaObserver for information on using Open Access observer template classes to derive and instantiate observers in an application.

Constructor & Destructor Documentation

oaObserver<oaWafer>::oaObserver (  oaUInt4    priorityIn,
oaBoolean    enabledIn = true
) 
 

This is the oaObserver<oaWafer> constructor. If multiple observers exist for a given oaWafer notification event, observers with a lower priorityIn value are called before those with a higher value.

Parameters:
priorityIn priority of this observer relative to other oaWafer observers
enabledIn Determines whether this observer is called when an observed event occurs

oaObserver<oaWafer>::~oaObserver (    )  [virtual]
 

This is the destructor for the oaObserver<oaWafer> class. This function destroys this oaObserver<oaWafer> object, deactivating and deleting this observer from the Wafer observer list, and freeing all resources associated with this observer.

Member Function Documentation

void oaObserver<oaWafer>::onFirstOpen (  oaWafer *    wafer )  [virtual]
 

This function is called when an oaWafer object is first opened. The application's derived class should implement this function to receive notification when an oaWafer object has been opened.

Parameters:
wafer A pointer to the newly-opened oaWafer object

void oaObserver<oaWafer>::onPostModify (  oaWafer *    wafer,
oaWaferModTypeEnum    modType
)  [virtual]
 

This function is called after an oaWafer object has been modified. The application's derived class should implement this function to receive notification when an oaWafer object has been modified.

Parameters:
wafer A pointer to the modified oaWafer object
modType The type of modification that was made

void oaObserver<oaWafer>::onPostReopen (  oaWafer *    wafer,
oaChar    oldMode
)  [virtual]
 

This function is called just after an oaWafer object is reopened using a new access mode. The application's derived class should implement this function to receive notification when an oaWafer object has been reopened in a new access mode.

Parameters:
wafer A pointer to the oaWafer object with the mode change
oldMode The mode with which the oaWafer object was previously opened

void oaObserver<oaWafer>::onPostSave (  oaWafer *    wafer,
oaBoolean    succeeded
)  [virtual]
 

This function is called after an attempt to save an oaWafer object to disk. The application's derived class should implement this function to receive notification when a save has been attempted on an oaWafer object.

Parameters:
wafer A pointer to the saved oaWafer object
succeeded A boolean that indicates whether the save was successful

void oaObserver<oaWafer>::onPostSaveAs (  oaWafer *    wafer,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName,
oaBoolean    succeeded
)  [virtual]
 

This function is called after an attempt has been made to save an oaWafer object to disk under a user-specified (usually new) library, cell and view names (through an oaWafer::saveAs call). The application's derived class should implement this function to receive notification when an attempt has been made to save an oaWafer object under user-specified library/cell/view names.

Parameters:
wafer A pointer to the saved oaWafer object
libName The library name of the saved oaWafer object
cellName The cell name of the saved oaWafer object
viewName The view name of the saved oaWafer object
succeeded a boolean that indicates whether the save was successful

void oaObserver<oaWafer>::onPreModify (  oaWafer *    wafer,
oaWaferModTypeEnum    modType
)  [virtual]
 

This function is called before an oaWafer object is modified. The application's derived class should implement this function to receive notification when an oaWafer object is about to be modified.

Parameters:
wafer A pointer to the oaWafer object to be modified
modType The type of modification to be made

void oaObserver<oaWafer>::onPreReopen (  oaWafer *    wafer,
oaChar    newMode
)  [virtual]
 

This function is called before an oaWafer object is reopened using a different access mode. The application's derived class should implement this function to receive notification when an oaWafer object is about to be reopened.

Parameters:
wafer A pointer to the oaWafer object with the mode change
newMode The new mode in which the oaWafer object will be reopened

void oaObserver<oaWafer>::onPreSave (  oaWafer *    wafer )  [virtual]
 

This function is called just before an oaWafer object is saved to disk. The application's derived class should implement this function to receive notification when an oaWafer object is about to be saved.

Parameters:
wafer A pointer to the oaWafer object to be saved

void oaObserver<oaWafer>::onPreSaveAs (  oaWafer *    wafer,
const oaScalarName &    libName,
const oaScalarName &    cellName,
const oaScalarName &    viewName
)  [virtual]
 

This function is called just before an attempt to save an oaWafer object to disk under user-specified (usually new) library, cell and view names (through an oaWafer::saveAs call). The application's derived class should implement this function to receive notification when an attempt is about to be made to save an oaWafer object under user-specified library/cell/view names.

Parameters:
wafer A pointer to the oaWafer object about to be saved
libName The library name of the oaWafer object to be saved
cellName The cell name of the oaWafer object to be saved
viewName The view name of the oaWafer object to be saved

void oaObserver<oaWafer>::onPurge (  oaWafer *    wafer )  [virtual]
 

This function is called when an oaWafer object is about to be purged from memory. The application's derived class should implement this function to receive notification when an oaWafer object is about to be purged.

Parameters:
wafer A pointer to the oaWafer object about to be purged

void oaObserver<oaWafer>::onTruncate (  oaWafer *    wafer )  [virtual]
 

This function is called just before an oaWafer object is truncated (for example, after all its contents are removed). The application's derived class should implement this function to receive notification when an oaWafer object is about to be truncated.

Parameters:
wafer A pointer to the oaWafer object about to be truncated

Friends And Related Function Documentation

friend class oaObserverCollectionPvt [friend]
 

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.