oaExportMarkerChangeRec Class Reference

Inheritance diagram for oaExportMarkerChangeRec:

oaMarkerChangeRec oaLeafChangeRec oaChangeRec


Public Methods

 oaExportMarkerChangeRec (oaChangeSetBase *changeSetIn, oaMarkerChangeRecTypeEnum typeIn, oaCMDatabaseRef::SPtr dbRef)
virtual oaMarkerChangeRec * clone ()
virtual void accept (oaChangeRecVisitor *visitor, oaBoolean forward=true)
oaString getMessage () const
void setMessage (const oaString &msg)

Detailed Description

The oaExportMarkerChangeRec class represents a marker type change record that is exported. The oaExportMarkerChangeRec object provides a mechanism to store a string with information about the export.

Constructor & Destructor Documentation

oaExportMarkerChangeRec::oaExportMarkerChangeRec (  oaChangeSetBase *    changeSetIn,
oaMarkerChangeRecTypeEnum    typeIn,
oaCMDatabaseRef::SPtr    dbRef
) 
 

This is the oaExportMarkerChangeRec constructor.

Parameters:
changeSetIn A pointer to the change set to contain the change record.
typeIn The enum value for the new change record.
dbRef A smart pointer to the database reference with which this marker change record is associated.

Member Function Documentation

void oaExportMarkerChangeRec::accept (  oaChangeRecVisitor *    visitor,
oaBoolean    forward = true
)  [virtual]
 

This function accepts a change record visitor to allow access to this change record. It calls the visit function of the specified visitor on this object.

The forward parameter indicates the direction in which the change records are being visited. The forward parameter might be set to false if the goal of the visit is to roll back changes due to an undo command.

Parameters:
visitor A pointer to the change record visitor to call on this object.
forward Specifies the direction in which change records are being visited.

Implements oaMarkerChangeRec.

oaMarkerChangeRec * oaExportMarkerChangeRec::clone (    )  [virtual]
 

This function creates an exact copy of the specified oaExportMarkerChangeRec, including an identical timestamp.

Implements oaMarkerChangeRec.

oaString oaExportMarkerChangeRec::getMessage (    )  const
 

This function returns the string message associated with this oaExportMarkerChangeRec object. Typically, the string specifies the library, cell, and view names of the target design in a "save as" operation.

void oaExportMarkerChangeRec::setMessage (  const oaString &    msg ) 
 

This function sets the string message for this oaExportMarkerChangeRec. Typically, the string specifies the library, cell, and view names of the target design in a "save as" operation.

Parameters:
msg The string message.

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.