oaObserver<oaLib> Class Template Reference

Inheritance diagram for oaObserver<oaLib>:

oaBaseObserver


Public Methods

 oaObserver (oaUInt4 priorityIn, oaBoolean enabledIn=true)
virtual ~oaObserver ()
virtual void onPostCreate (oaLib *lib)
virtual void onPostOpen (oaLib *lib)
virtual void onPreClose (oaLib *lib)
virtual void onPreModify (oaLib *lib, oaDMLibModTypeEnum modType)
virtual void onPostModify (oaLib *lib, oaDMLibModTypeEnum modType)

Detailed Description

template<>
class oaObserver<oaLib>

This base template class can be used to derive observers for oaLib objects. It supports postCreate, postOpen, preModify, postModify, and preClose 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<oaLib>::oaObserver (  oaUInt4    priorityIn,
oaBoolean    enabledIn = true
) 
 

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

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

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

Member Function Documentation

void oaObserver<oaLib>::onPostCreate (  oaLib *    lib )  [virtual]
 

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

Parameters:
lib A pointer to the created oaLib object.

void oaObserver<oaLib>::onPostModify (  oaLib *    lib,
oaDMLibModTypeEnum    modType
)  [virtual]
 

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

Parameters:
lib A pointer to the modified oaLib object.
modType An oaDMLibModTypeEnum value that indicates the type of modification that was made.

void oaObserver<oaLib>::onPostOpen (  oaLib *    lib )  [virtual]
 

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

Parameters:
lib A pointer to the opened oaLib object.

void oaObserver<oaLib>::onPreClose (  oaLib *    lib )  [virtual]
 

This function is called before an oaLib is closed. The application's derived class should implement this function to receive notification when a library object is about to be closed.

Parameters:
lib A pointer to the library object to be closed.

void oaObserver<oaLib>::onPreModify (  oaLib *    lib,
oaDMLibModTypeEnum    modType
)  [virtual]
 

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

Parameters:
lib A pointer to the oaLib object to be modified.
modType An oaDMLibModTypeEnum value that indicates the type of modification to be made.

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.