oaPcellFileObserver Class Reference


Public Methods

 oaPcellFileObserver (oaUInt4 priorityIn, oaBoolean enabledIn=true)
virtual ~oaPcellFileObserver ()
virtual void onRead (oaDesign *design, PcellFile *file, oaUInt8 offset)
virtual void onPreAppend (oaDesign *design, PcellFile *file)
virtual void onPostAppend (oaDesign *design, PcellFile *file)
oaBoolean isEnabled ()
void enable (oaBoolean enabledIn)
oaUInt4 getPriority () const

Detailed Description

The oaPcellFileObserver class is a base class for PcellFile observers. It supports onRead, preAppend, and postAppend event notifications.

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

Constructor & Destructor Documentation

oaPcellFileObserver::oaPcellFileObserver (  oaUInt4    priorityIn,
oaBoolean    enabledIn = true
) 
 

This is the constructor for the oaPcellFileObserver class. It adds this observer to the list of PCellFile observers. priorityIn is used to determine where the observer should be inserted. The observers are ordered by the priority from lowest to highest.

Parameters:
priorityIn Priority of this observer relative to other oaPcellFileObserver
enabledIn Determines whether this observer is called when an observed event occurs

oaPcellFileObserver::~oaPcellFileObserver (    )  [virtual]
 

This is the destructor for the oaPcellFileObserver class. It removes this observer from the PCellFile observer list.

Member Function Documentation

void oaPcellFileObserver::enable (  oaBoolean    enabledIn ) 
 

This function activates or deactivates this observer.

Parameters:
enabledIn Indicates whether to make this observer active or inactive

oaUInt4 oaPcellFileObserver::getPriority (    )  const
 

This function returns the priority of this observer.

oaBoolean oaPcellFileObserver::isEnabled (    ) 
 

This function returns a boolean value indicating whether this observer is active.

void oaPcellFileObserver::onPostAppend (  oaDesign *    design,
PcellFile *    file
)  [virtual]
 

This function is called just after a pcell subMaster is appended to a PcellFile. The application's derived class should implement this function to receive notification when a pcell subMaster has been appended to a PcellFile.

Parameters:
design A pointer to the pcell subMaster
file A pointer to the PCellFile being appended.

void oaPcellFileObserver::onPreAppend (  oaDesign *    design,
PcellFile *    file
)  [virtual]
 

This function is called just before a pcell subMaster is appended to a PcellFile. The application's derived class should implement this function to receive notification when a pcell subMaster is about to be appended to a PcellFile.

Parameters:
design A pointer to the pcell subMaster
file A pointer to the PCellFile being appended.

void oaPcellFileObserver::onRead (  oaDesign *    design,
PcellFile *    file,
oaUInt8    offset
)  [virtual]
 

This function is called when a pcell subMaster is read from a PCellFile. The application's derived class should implement this function to receive notification when a pcell subMaster is read from a PcellFile.

Parameters:
design A pointer to the pcell subMaster being read.
file A pointer to the PcellFile from which the pcell subMaster is read.
offset The offset of the PcellFile from where the pcell subMaster is read.

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.