oaObserver<oaGroupDef> Class Template Reference

Inheritance diagram for oaObserver<oaGroupDef>:

oaBaseObserver


Public Methods

 oaObserver (oaUInt4 priorityIn, oaBoolean enabledIn=true)
virtual ~oaObserver ()
virtual void onPreDestroy (oaGroupDef *def)
virtual void onPostCreate (oaGroupDef *def)
virtual void onConflict (const oaString &name, oaType defType)

Static Public Methods

oaBoolean hasObservers ()

Detailed Description

template<>
class oaObserver<oaGroupDef>

This base template class can be used to derive observers for oaGroupDef objects. It supports preDestroy, postCreate and onConflict event notifications.

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

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

oaBoolean oaObserver<oaGroupDef>::hasObservers (    )  [inline, static]
 

This function returns true if any observers for this type are active.

void oaObserver<oaGroupDef>::onConflict (  const oaString &    name,
oaType    defType
)  [virtual]
 

This function is called if an on-disk oaGroupDef conflicts with an existing oaGroupDef definition. Note that that all data associated with the conflicting definition, including the definition itself, will be destroyed following this notification.

Parameters:
name name of the conflicting oaGroupDef
defType type of the conflicting oaGroupDef

void oaObserver<oaGroupDef>::onPostCreate (  oaGroupDef *    def )  [virtual]
 

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

Parameters:
def pointer to the created oaGroupDef object

void oaObserver<oaGroupDef>::onPreDestroy (  oaGroupDef *    def )  [virtual]
 

This function is called before an oaGroupDef is destroyed. The application's derived observer class should implement this function to receive notification when an oaGroupDef is about to be destroyed.

Parameters:
def pointer to the oaGroupDef about to be destroyed

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.