oaObserver<oaDMData> Class Template Reference

Inheritance diagram for oaObserver<oaDMData>:

oaBaseObserver


Public Methods

 oaObserver (oaUInt4 priorityIn, oaBoolean enabledIn=true)
virtual ~oaObserver ()
virtual void onFirstOpen (oaDMData *dmData)
virtual void onPurge (oaDMData *dmData)
virtual void onTruncate (oaDMData *dmData)
virtual void onPreReopen (oaDMData *dmData, oaChar newMode)
virtual void onPostReopen (oaDMData *dmData, oaChar oldMode)
virtual void onPreSave (oaDMData *dmData)
virtual void onPostSave (oaDMData *dmData, oaBoolean succeeded)

Detailed Description

template<>
class oaObserver<oaDMData>

oaObserver<oaDMData> is a base observer class for oaDMData object observers. It supports onFirstOpen, onPurge, onPreSave, onPostSave, onPreReopen, onPostReopen, 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<oaDMData>::oaObserver (  oaUInt4    priorityIn,
oaBoolean    enabledIn = true
) 
 

This is the oaObserver<oaDMData> constructor. If multiple observers exist for a given oaDMData 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 oaDMData observers
enabledIn Determines whether this observer is called when an observed event occurs

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

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

Member Function Documentation

void oaObserver<oaDMData>::onFirstOpen (  oaDMData *    dmData )  [virtual]
 

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

Parameters:
dmData A pointer to the newly-opened oaDMData

void oaObserver<oaDMData>::onPostReopen (  oaDMData *    dmData,
oaChar    oldMode
)  [virtual]
 

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

Parameters:
dmData A pointer to the oaDMData object with the mode change
oldMode The mode with which the design was previously opened

void oaObserver<oaDMData>::onPostSave (  oaDMData *    dmData,
oaBoolean    succeeded
)  [virtual]
 

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

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

void oaObserver<oaDMData>::onPreReopen (  oaDMData *    dmData,
oaChar    newMode
)  [virtual]
 

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

Parameters:
dmData A pointer to the oaDMData object with the mode change
newMode The new mode in which the design will be reopened

void oaObserver<oaDMData>::onPreSave (  oaDMData *    dmData )  [virtual]
 

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

Parameters:
dmData A pointer to the oaDMData about to be saved

void oaObserver<oaDMData>::onPurge (  oaDMData *    dmData )  [virtual]
 

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

Parameters:
dmData A pointer to the oaDMData object about to be purged

void oaObserver<oaDMData>::onTruncate (  oaDMData *    dmData )  [virtual]
 

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

Parameters:
dmData A pointer to the oaDMData object about to be truncated

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.