oaObserver<oaDesign> Class Template Reference

Inheritance diagram for oaObserver<oaDesign>:

oaBaseObserver


Public Methods

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

Detailed Description

template<>
class oaObserver<oaDesign>

This base template class can be used to derive observers for oaDesign objects. It supports open, purge, preSave, postSave, preSaveAs, postSaveAs, preReopen, postReopen, and truncate event notifications.

See oaDesign Observer Notification, Binding, and Loading in the Programmers Guide for more information on using design observers.

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

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

void oaObserver<oaDesign>::onFirstOpen (  oaDesign *    design )  [virtual]
 

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

Parameters:
design A pointer to the newly-opened design

void oaObserver<oaDesign>::onPostModify (  oaDesign *    design,
oaDesignModTypeEnum    modType
)  [virtual]
 

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

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

void oaObserver<oaDesign>::onPostReopen (  oaDesign *    design,
oaChar    oldMode
)  [virtual]
 

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

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

void oaObserver<oaDesign>::onPostSave (  oaDesign *    design,
oaBoolean    succeeded
)  [virtual]
 

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

Parameters:
design A pointer to the saved design
succeeded A boolean that indicates whether the save was successful

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

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

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

void oaObserver<oaDesign>::onPreModify (  oaDesign *    design,
oaDesignModTypeEnum    modType
)  [virtual]
 

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

Parameters:
design A pointer to the oaDesign object to be modified
modType The type of modification to be made

void oaObserver<oaDesign>::onPreReopen (  oaDesign *    design,
oaChar    newMode
)  [virtual]
 

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

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

void oaObserver<oaDesign>::onPreSave (  oaDesign *    design )  [virtual]
 

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

Parameters:
design A pointer to the design about to be saved

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

This function is called just before an attempt to save a design to disk under user-specified (usually new) library, cell and view names (through an oaDesign::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 oaDesign object under user-specified library/cell/view names.

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

void oaObserver<oaDesign>::onPurge (  oaDesign *    design )  [virtual]
 

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

Parameters:
design A pointer to the design about to be purged

void oaObserver<oaDesign>::onTruncate (  oaDesign *    design )  [virtual]
 

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

Parameters:
design A pointer to the design 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.